Xceed Logo
Shop
Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid Namespace / GridElement Class
Members


In This Topic
    GridElement Class
    In This Topic
    Represents any element in the grid and exposes properties and methods that allow their manipulations.
    Syntax
    'Declaration
 
<DesignerAttribute("Xceed.Grid.Design.GridElementDesigner,Xceed.Grid.v4.3.Design,Version=4.3.25455.6282,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")>
<DesignTimeVisibleAttribute(False)>
<DefaultPropertyAttribute("BackColor")>
<DefaultEventAttribute("BackColorChanged")>
<ToolboxItemAttribute(False)>
Public MustInherit Class GridElement 
   Inherits GridElementBase
    'Usage
 
Dim instance As GridElement
    [Designer("Xceed.Grid.Design.GridElementDesigner,Xceed.Grid.v4.3.Design,Version=4.3.25455.6282,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")]
[DesignTimeVisible(false)]
[DefaultProperty("BackColor")]
[DefaultEvent("BackColorChanged")]
[ToolboxItem(false)]
public abstract class GridElement : GridElementBase
    Remarks

    When setting properties that modify the contents of a grid element, for example the Font or ForeColor properties, it is important to remember that if the grid element is a cell, then only the cell will be modified. If the grid element is a row or column, then all the cells in the row or column will be modified.

    The GridElement class implements the System.ComponentModel.IComponent interface which derives from the System.IDisposable interface. This was necessary in order for each grid element to be a component in the Grid Designer and thus individually selectable. It is not necessary however to call the System.IDisposable.Dispose method on the GridElement class nor on any class that derives from the GridElement class.

    When creating a class that derives from GridElement (or any of its derived classes), code should not be placed within the System.IDisposable.Dispose method since Dispose will not be called.
    Inheritance Hierarchy

    System.Object
       System.MarshalByRefObject
          Xceed.Grid.GridElementBase
             Xceed.Grid.GridElement
                Xceed.Grid.Column
                Xceed.Grid.GroupBase
                Xceed.Grid.VisualGridElement

    Public Properties
     NameDescription
    Public PropertyAlignmentGets the alignment of the element's content.  
    Public PropertyAmbientParentGets the ambient parent of the grid element.  
    Public PropertyBackColorGets or sets the background color of the grid element.  
    Public PropertyClipPartialLineGets or sets a boolean value indicating if partial lines should be clipped.  
    Public PropertyFontGets or sets the font of the grid element.  
    Public PropertyForeColorGets or sets the foreground color of the grid element.  
    Public PropertyGridControlGets the GridControl in which all the grid elements are contained.  
    Public PropertyHorizontalAlignmentGets or sets the horizontal alignment of the grid element's content.  
    Public PropertyIsBackColorAmbientGets a boolean value indicating if the BackColor property gets its value from its parent.  
    Public PropertyIsClipPartialLineAmbientGets a boolean value indicating if the ClipPartialLine property gets its value from its parent.  
    Public PropertyIsFontAmbientGets a boolean value indicating if the Font property gets its value from its parent.  
    Public PropertyIsForeColorAmbientGets a boolean value indicating if the ForeColor property gets its value from its parent.  
    Public PropertyIsHorizontalAlignmentAmbientGets a boolean value indicating if the HorizontalAlignment property gets its value from its parent.  
    Public PropertyIsOverrideUIStyleAmbientGets a boolean value indicating if the OverrideUIStyle property gets its value from its parent.  
    Public PropertyIsOverrideUIStyleDefinedGets a boolean value indicating whether the OverrideUIStyle property has been explicitly set.  
    Public PropertyIsReadOnlyAmbientGets a boolean value indicating if the ReadOnly property gets its value from its parent.  
    Public PropertyIsReportStyleDefinedGets a boolean value indicating if one or more properties of the ReportStyle have been explicitly set.  
    Public PropertyIsTrimmingAmbientGets a boolean value indicating if the Trimming property gets its value from its parent.  
    Public PropertyIsVerticalAlignmentAmbientGets a boolean value indicating if the VerticalAlignment property gets its value from its parent.  
    Public PropertyIsWordWrapAmbientGets a boolean value indicating if the WordWrap property gets its value from its parent.  
    Public PropertyOverrideUIStyleGets or sets a boolean value indicating whether any theming based on the UIStyle property of the GridControl will be overridden.  
    Public PropertyParentGridGets the parent grid of the grid element.  
    Public PropertyReadOnlyGets or sets a boolean value indicating if the content of cell(s) can be edited.  
    Public PropertyReportStyleGets the report style of the grid element.  
    Public PropertyTagGets or sets the object that contains data about the grid element.  
    Public PropertyTrimmingGets or sets a value indicating how text displayed in the cell will be trimmed when it exceeds the edges of the layout rectangle.  
    Public PropertyVerticalAlignmentGets or sets the vertical alignment of the grid element's content.  
    Public PropertyVisibleGets or sets a boolean value indicating if the GridElement is visible.  
    Public PropertyWordWrapGets or sets a boolean value indicating if the text of the grid element should be wrapped.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyAmbientBackColorGets the ambient value of the grid element's BackColor property.  
    Protected PropertyAmbientClipPartialLineGets the ambient value of the grid element's ClipPartialLine property.  
    Protected PropertyAmbientFontGets the ambient value of the grid element's Font property.  
    Protected PropertyAmbientForeColorGets the ambient value of the grid element's ForeColor property.  
    Protected PropertyAmbientHorizontalAlignmentGets the ambient value of the grid element's HorizontalAlignment property.  
    Protected PropertyAmbientOverrideUIStyleGets the ambient value of the grid elements's OverrideUIStyle property.  
    Protected PropertyAmbientReadOnlyGets the ambient value of the grid element's ReadOnly property.  
    Protected PropertyAmbientTrimmingGets the ambient value of the grid element's Trimming property.  
    Protected PropertyAmbientVerticalAlignmentGets the ambient value of the grid element's VerticalAlignment property.  
    Protected PropertyAmbientWordWrapGets the ambient value of the grid element's WordWrap property.  
    Protected PropertyDefaultBackColorGets the default value of the BackColor property.  
    Protected PropertyDefaultClipPartialLineGets the default value of the ClipPartialLine property.  
    Protected PropertyDefaultFontGets the default value of the Font property  
    Protected PropertyDefaultForeColorGets the default value of the ForeColor property  
    Protected PropertyDefaultHorizontalAlignmentGets the default value of the HorizontalAlignment property.  
    Protected PropertyDefaultOverrideUIStyleGets the default value of the OverrideUIStyle property.  
    Protected PropertyDefaultReadOnlyGets the default value of the ReadOnly property.  
    Protected PropertyDefaultTagGets the default value of the Tag property.  
    Protected PropertyDefaultTrimmingGets the default value of the Trimming property.  
    Protected PropertyDefaultVerticalAlignmentGets the default value of the VerticalAlignment property.  
    Protected PropertyDefaultVisibleGets the default value of the Visible property.  
    Protected PropertyDefaultWordWrapGets the default value of the WordWrap property.  
    Protected PropertyEventsGets a list of the events to which the grid element is subscribed. (Inherited from Xceed.Grid.GridElementBase)
    Protected PropertyParentVisibleGets a boolean value indicating if the GridElement's parent is visible.  
    Protected PropertyPropertiesGets a collection of property names whose values have been explicitly set as well as the corresponding values. (Inherited from Xceed.Grid.GridElementBase)
    Protected Internal PropertyThemeThis property is reserved for internal use and is not intended to be used directly from your code.  
    Top
    Public Methods
     NameDescription
    Public MethodBringIntoViewBrings the grid element into the visible area of the grid.  
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodResetBackColorResets the value of the BackColor property to its default value, DefaultBackColor.  
    Public MethodResetClipPartialLineResets the value of the ClipPartialLine property to its default value, DefaultClipPartialLine.  
    Public MethodResetFontResets the value of the Font property to its default value, DefaultFont.  
    Public MethodResetForeColorResets the value of the ForeColor property to its default value, DefaultForeColor.  
    Public MethodResetHorizontalAlignmentResets the value of the HorizontalAlignment property to its default value, DefaultHorizontalAlignment.  
    Public MethodResetOverrideUIStyleResets the value of the OverrideUIStyle property to its default value, DefaultOverrideUIStyle.  
    Public MethodResetReadOnlyResets the value of the ReadOnly property to its default value, DefaultReadOnly.  
    Public MethodResetReportStyleResets the property values of the ReportStyle.  
    Public MethodResetStyleResets the values of the properties affected by a GridElementStyle to their default values.  
    Public MethodResetTagResets the value of the Tag property to its default value, DefaultTag.  
    Public MethodResetTrimmingResets the value of the Trimming property to its default value, DefaultTrimming.  
    Public MethodResetVerticalAlignmentResets the value of the VerticalAlignment property to its default value, DefaultVerticalAlignment.  
    Public MethodResetVisibleResets the value of the Visible property to its default value, DefaultVisible.  
    Public MethodResetWordWrapResets the value of the WordWrap property to its default value, DefaultWordWrap.  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodAddHandler (Inherited from Xceed.Grid.GridElementBase)
    Protected Internal MethodGetPropertyValueRetrieves the value of the specified property in the Properties collection. (Inherited from Xceed.Grid.GridElementBase)
    Protected Internal MethodIsPropertyDefinedRetrieves a boolean value indicating if the specified property has been explicitly set. (Inherited from Xceed.Grid.GridElementBase)
    Protected MethodIsTemplatePropertyDefined (Inherited from Xceed.Grid.GridElementBase)
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodOnBackColorChangedRaises the BackColorChanged event.  
    Protected MethodOnClipPartialLineChangedRaises the ClipPartialLineChanged event.  
    Protected MethodOnFontChangedRaises the FontChanged event.  
    Protected MethodOnForeColorChangedRaises the ForeColorChanged event.  
    Protected MethodOnHorizontalAlignmentChangedRaises the HorizontalAlignmentChanged event.  
    Protected MethodOnOverrideUIStyleChangedRaises the OverrideUIStyleChanged event.  
    Protected MethodOnReadOnlyChangedRaises the ReadOnlyChanged event.  
    Protected MethodOnTrimmingChangedRaises the TrimmingChanged event.  
    Protected MethodOnVerticalAlignmentChangedRaises the VerticalAlignmentChanged event.  
    Protected MethodOnVisibleChangedRaises the VisibleChanged event.  
    Protected MethodOnWordWrapChangedRaises the WordWrapChanged event.  
    Protected MethodRaiseEventRaises the specified event. (Inherited from Xceed.Grid.GridElementBase)
    Protected Internal MethodRemoveHandler (Inherited from Xceed.Grid.GridElementBase)
    Protected MethodRemovePropertyValueRemoves the specified property from the Properties collection. (Inherited from Xceed.Grid.GridElementBase)
    Protected Internal MethodSetPropertyValue (Inherited from Xceed.Grid.GridElementBase)
    Protected MethodSetVisibleCoreThis method is reserved for internal use and is not intended to be used directly from your code.  
    Top
    Public Events
     NameDescription
    Public EventBackColorChangedRaised when the value of the BackColor property is changed.  
    Public EventClipPartialLineChangedRaised when the value of the ClipPartialLine property is changed.  
    Public EventFontChangedRaised when the value of the Font property is changed.  
    Public EventForeColorChangedRaised when the value of the ForeColor property is changed.  
    Public EventHorizontalAlignmentChangedRaised when the value of the HorizontalAlignment property is changed.  
    Public EventOverrideUIStyleChangedRaised when the value of the OverrideUIStyle property is changed.  
    Public EventReadOnlyChangedRaised when the value of the ReadOnly property is changed.  
    Public EventTrimmingChangedRaised when the value of the Trimming property is changed.  
    Public EventVerticalAlignmentChangedRaised when the value of the VerticalAlignment property is changed.  
    Public EventVisibleChangedRaised when the value of the Visible property is changed.  
    Public EventWordWrapChangedRaised when the value of the WordWrap property is changed.  
    Top
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    GridElement Members
    Xceed.Grid Namespace

    Send Feedback