Infragistics(R) NetAdvantage(R) Windows Forms
UltraGridLayout Class Members
See Also  Fields  Properties  Methods  Events E-mail your feedback on this topic.
Infragistics.Win.UltraWinGrid Namespace : UltraGridLayout Class


The following tables list the members exposed by UltraGridLayout.

Public Constructors

 NameDescription
public ConstructorUltraGridLayout ConstructorOverloaded.   
Top

Protected Fields

 NameDescription
protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Top

Public Properties

 NameDescription
public PropertyActiveRow Returns the active row. This property is not available at design-time.  
public PropertyAddNewBox The AddNewBox object represents the AddNew Box interface for entering new data rows into the grid.  
public PropertyAllowCardPrinting Specifies whether the grid should honor the CardView property on the band when printing.  
public PropertyAppearance Returns or sets the Appearance object that controls the object's formatting.  
public PropertyAppearances A collection of all the Appearance objects created for use with this control.  
public PropertyAutoFitStyle Specifies whether the AutoFitColumns feature is enabled. This feature automatically resizes the column widths proportionally to fit the visible area of the grid.  
public PropertyBands A collection of UltraGridBand objects. When used at the grid level, the collection includes all the UltraGridBand objects in the control.  
public PropertyBorderStyleSpecifies the style that will be used for the border of the Grid control. T:Infragistics.Win.UIElementBorderStyle  
public PropertyBorderStyleCaptionReturns or sets the border style of the control's caption area. T:Infragistics.Win.UIElementBorderStyle  
public PropertyCaptionAppearanceSets the formatting attributes of an object's caption based upon the Appearance object. T:Infragistics.Win.Appearance  
public PropertyCaptionVisible Gets/sets whether the grid's caption area will be displayed. By default the caption area will be displayed if the control's Text property is not an empty string.  
public PropertyCellHottrackInvalidationStyle Specifies whether to invalidate the cell when the mouse enters or leaves it.  
public PropertyClipboardCellDelimiter Specifies the cell value delimiter when copying to the clipboard.  
public PropertyClipboardCellSeparator Specifies the cell value separator when copying to the clipboard.  
public PropertyClipboardRowSeparator Specifies the logical row separator when copying to the clipboard.  
public PropertyColScrollRegions A collection of column scrolling region objects.  
public PropertyColumnChooserEnabled This specifies that the column chooser user interface is enabled for this UltraGrid. The UltraGrid uses this as a hint to let the user hide columns by dragging and dropping them outside of the UltraGrid and also unhide an explicitly hidden group-by column by dragging and dropping it over the column headers.  
public PropertyColumnScrollbarSmallChange Specifies the small change for the horizontal scrollbar in a column scroll region. Default is 30.  
public PropertyDefaultSelectedBackColor Gets or sets the default color used for the backcolor of selected cells in the grid.  
public PropertyDefaultSelectedForeColor Gets or sets the default color used for the forecolor of selected cells in the grid.  
public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
public PropertyEmptyRowSettings This object contains the settings for empty rows.  
public PropertyFilterDropDownButtonImage Gets or sets the image that's used to draw the filter drop down buttons on the column headers.  
public PropertyFilterDropDownButtonImageActive Gets or sets the image that's used to draw the filter drop down buttons on the column headers when there is a row filter active on the column.  
public PropertyFilterOperatorsValueList Retruns the value list that will be used for the operator drop down list in the filter row as well as in the custom filter dialog.  
public PropertyFixedHeaderOffImage Gets or sets the image that's used to draw the fixed header indicator when the header is not fixed.  
public PropertyFixedHeaderOnImage Gets or sets the image that's used to draw the fixed header indicator when the header is fixed.  
public PropertyFixedRowOffImage Gets or sets the image that's used to draw the fixed row indicator when the row is not fixed.  
public PropertyFixedRowOnImage Gets or sets the image that's used to draw the fixed row indicator when the row is fixed.  
public PropertyGrid Returns the associated UltraGridBase instance or null if not set (read-only).  
public PropertyGroupByBoxReturns a reference to the GroupByBox object associated wiht the layout. The GroupByBox is used to specify GroupBy rows when the control is in GroupBy mode. GroupByBox  
public PropertyHasAddNewBox Returns true if an AddNewBox object has been created.  
public PropertyHasAppearance Returns true if an Appearance object has been created.  
public PropertyHasCaptionAppearance Returns true if an CaptionAppearance object has been created.  
public PropertyHasOverride Returns true if an UltraGridOverride object has been created.  
public PropertyHasValueLists Returns true if an valuelist object has been created.  
public PropertyInitializingAllSubItems Determines whether sub-items are currently being initialized. This property is read-only and is only available at run-time.  
public PropertyInterBandSpacing Returns or sets the vertical space between bands.  
public PropertyIsDisplayLayout Returns true if this is the grid's main display layout.  
public PropertyIsDrawing Returns true if the layout is currently being rendered.  
public PropertyIsExportLayout Indicates whether this layout is an export layout.  
public PropertyIsPrintLayout Returns true if this is the layout being used for printing.  
public PropertyKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
public PropertyLoadStyleSpecifies how rows are loaded. Default value is PreloadRows.  
public PropertyMaxBandDepthGets or sets the max band depth. Grid will load upto MaxBandDepth number of bands. Note that you have to set the MaxBandDepth before binding the UltraGrid.  
public PropertyMaxColScrollRegions Returns or sets the maximum number of column scrolling regions.  
public PropertyMaxRowScrollRegions Returns or sets the maximum number of row scrolling regions.  
public PropertyNewBandLoadStyleSpecifies how to load new columns from data source. Default value is Show.  
public PropertyNewColumnLoadStyleSpecifies how to load new columns from data source. Default value is Show.  
public PropertyOverrideThe UltraGridOverride object is used to determine the behavior of bands in the grid. Applying an UltraGridOverride to an object replaces that object's default behavior with the behavior specified by the settings of the UltraGridOverride. The DisplayLayout object has an Override property setting that determines the default settings for all UltraGridBands. The UltraGridBand object also has an Override property for settings specific to that band.  
public PropertyPriorityScrolling Gets/sets whether callbacks made during a scroll operation occur synchronously or asynchronously.  
public PropertyRowConnectorColor Returns or sets the color of the lines used to connect rows.  
public PropertyRowConnectorColorResolved Returns the resolved color of the RowConnector lines.  
public PropertyRowConnectorStyle Returns or sets the style of the lines used to connect rows.  
public PropertyRowConnectorStyleResolved Returns the resolved Row Connector Style.  
public PropertyRowsReturns the row collection associated with this layout. For display layout this is the same as the UltraGridBase.Rows.  
public PropertyRowScrollRegions A collection of row scrolling region objects.  
public PropertyRowSelectorImages Gets the RowSelectorImageInfo object containing the state-specific row selector images.  
public PropertyScrollbarIntersectionAppearance Appearance for the square area at the lower right corner where a vertical and horizontal scrollbar meet.  
public PropertyScrollBarLook Determines the appearance of the scroll bars.  
public PropertyScrollbars Returns or sets a value that determines whether horizontal and/or vertical scrollbars are shown.  
public PropertyScrollBoundsSpecifies the vertical scrolling behavior in regard to how the UltraGrid scrolls rows. Default is ScrollToLastItem.  
public PropertyScrollStyle Controls how vertical row scrolling is done in the grid.  
public PropertySelectionOverlayBorderColor Gets or sets the color used for the borders drawn around the selection overlay.  
public PropertySelectionOverlayBorderThickness Gets or sets the thickness of the borders drawn around the selection overlay.  
public PropertySelectionOverlayColor Gets or sets the color used to overlay the selection area of the grid. This property overrides the default selection colors.  
public PropertySortedBands A sorted collection of UltraGridBand objects. The collection includes all the UltraGridBand objects in the control in the order in which they will be displayed.  
public PropertySortIndicatorAscendingImage Gets or sets the image that's used to draw the sort button on the column headers.  
public PropertySortIndicatorDescendingImage Gets or sets the image that's used to draw the sort button on the column headers.  
public PropertySplitterBarHorizontalAppearance Appearance for the horizontal splitter bar and the split box.  
public PropertySplitterBarVerticalAppearance Appearance for the vertical splitter bar and the split box.  
public PropertySplitterBarWidth The width of the splitterbars based on the splitter border style (read-only)  
public PropertySummaryButtonImage This image will be drawn on the column headers for summary rows icon. Summary rows icon is the icon that shows up on the column headers when summaries are enabled on that column. User can click on this icon to select summaries he/she wants performed on the associated field.  
public PropertyTabNavigation Returns or sets a value that indicates how the control will respond when the TAB key is pressed.  
public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
public PropertyUIElement The main UIElement for the grid (read-only)  
public PropertyUseFixedHeaders Specifies whether the fixed-headers feature is enabled. Fixed-headers feature lets you fix (freeze) columns so they do not scroll when the grid is scrolled horizontally.  
public PropertyUseOptimizedDataResetMode Gets or sets whether the grid will use a caching mechanism when receiving a Reset notification from the underlying DataSource when using LoadOnDemand.  
public PropertyUseScrollWindow Specifies whether to use scroll window when scrolling the grid.  
public PropertyValueLists Returns a collection of ValueList objects. This property is read-only at run-time. This property is not available at design-time.  
public PropertyViewStyle Returns or sets a value that determines the type of view displayed by the control.  
public PropertyViewStyleBand Returns or sets a value that determines the type of view displayed by the control.  
Top

Protected Properties

 NameDescription
protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Top

Public Methods

 NameDescription
public MethodClearGroupByColumns Removes all the group by columns from all the bands ungrouping all the rows.  
public MethodCloneOverloaded.  Creates and returns a reference to a clone (identical copy) of this object.  
public MethodCopyFromOverloaded.  Applies the attributes of an existing UltraGridLayout object to the current UltraGridLayout object, using the property categories specified.  
public MethodCreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
public MethodGetCachedGraphics Called to get a graphics object suitable for doing metrics calculations only.  
public MethodGetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
public MethodInitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
public MethodLoadOverloaded.  Loads a layout from a stream, including all properties.  
public MethodLoadFromXmlOverloaded.  Loads a layout from stream, including all properties.  
public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
public MethodPerformAutoResizeCards Resizes the width of all cards in every band based on cell values in all rows.  
public MethodPerformAutoResizeColumnsOverloaded.  Resizes all columns in all bands based on cell values in either currently visible rows or all rows depending on the value of autoSizeType argument.  
public MethodRefreshFilters Reevaluates the filters on the rows.  
public MethodRefreshSummaries Reevaluates the summaries.  
public MethodReleaseCachedGraphicsCalled to release a graphics object that was returned from a prior call to UltraGridLayout.GetCachedGraphics.  
public MethodReset Resets all Layout properties back to their default values  
public MethodResetAddNewBox Resets the AddNew box  
public MethodResetAllowCardPrintingResets the UltraGridLayout.AllowCardPrinting property to its default value of Never.  
public MethodResetAppearance Resets the Appearance object associated with the Displaylayout.  
public MethodResetAppearanceHolders Resets all appearanceHolders in the appearanceHolder array  
public MethodResetAppearances Reset appearances to null  
public MethodResetAutoFitColumns Resets AutoFitColumns to its default value (false).  
public MethodResetAutoFitStyleResets ResetAutoFitStyle to its default value of None.  
public MethodResetBands Calls the Reset method on each band  
public MethodResetBorderStyle Resets BorderStyle to its default value.  
public MethodResetBorderStyleCaption Resets BorderStyleCaption to its default value.  
public MethodResetCaptionAppearance Reset appearance  
public MethodResetCaptionVisibleResets the UltraGridLayout.CaptionVisible to 'Default'.  
public MethodResetCellHottrackInvalidationStyle Resets the property to its default value.  
public MethodResetClipboardCellDelimiter Resets the property to its default value.  
public MethodResetClipboardCellSeparator Resets the property to its default value.  
public MethodResetClipboardRowSeparator Resets the property to its default value.  
public MethodResetColScrollRegions Resets ColSrollRegions. The control will revert to having one main column scrolling region.  
public MethodResetColumnChooserEnabledResets the UltraGridLayout.ColumnChooserEnabled to Default.  
public MethodResetColumnScrollbarSmallChange Resets the ColumnScrollbarSmallChange property to its default vlaue of 30.  
public MethodResetDefaultSelectedBackColorResets the UltraGridLayout.DefaultSelectedBackColor property to its default value.  
public MethodResetDefaultSelectedForeColorResets the UltraGridLayout.DefaultSelectedForeColor property to its default value.  
public MethodResetEmptyRowSettings Resets the property to its default value.  
public MethodResetFilterDropDownButtonImage Resets the property to its default value.  
public MethodResetFilterDropDownButtonImageActive Resets the property to its default value.  
public MethodResetFilterOperatorsValueList Resets the property to its default value.  
public MethodResetFixedHeaderOffImage Resets the property to its default value.  
public MethodResetFixedHeaderOnImage Resets the property to its default value.  
public MethodResetFixedRowOffImage Resets the property to its default value.  
public MethodResetFixedRowOnImage Resets the property to its default value.  
public MethodResetGroupByBox Reset addnewbox  
public MethodResetInterBandSpacing Resets border interband spacing to its default value (5).  
public MethodResetKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
public MethodResetLoadStyleResets the UltraGridLayout.LoadStyle to its default value of PreloadRows.  
public MethodResetMaxBandDepth Resets the MaxBandDepth property to its default value 100.  
public MethodResetMaxColScrollRegions Resets MaxColScrollRegions to its default value (10).  
public MethodResetMaxRowScrollRegions Resets ResetMaxRowScrollRegions to its default value (10).  
public MethodResetNewBandLoadStyleResets the property to its default value of Show.  
public MethodResetNewColumnLoadStyleResets the property to its default value of Show.  
public MethodResetOverride Reset override  
public MethodResetPriorityScrolling Resets ScrollStyle to its default value (false).  
public MethodResetRowConnectorColor Resets RowConnectorColor to its default value.  
public MethodResetRowConnectorStyle Resets RowConnectorStyle to its default value.  
public MethodResetRowScrollRegions Resets row scroll regions. The control will revert to having one main row scrolling region.  
public MethodResetRowSelectorImages Resets the RowSelectorImages object  
public MethodResetScrollbarIntersectionAppearance Resets the property to its default value.  
public MethodResetScrollBarLook Resets the property to its default value.  
public MethodResetScrollbars Resets Scrollbars to its default value (Automatic).  
public MethodResetScrollBoundsResets the UltraGridLayout.ScrollBounds property to its default value of ScrollToLastItem.  
public MethodResetScrollStyle Resets ScrollStyle to its default value (Deferred).  
public MethodResetSelectionOverlayBorderColorResets the UltraGridLayout.SelectionOverlayBorderColor property to its default value.  
public MethodResetSelectionOverlayBorderThicknessResets the UltraGridLayout.SelectionOverlayBorderThickness property to its default value.  
public MethodResetSelectionOverlayColorResets the UltraGridLayout.SelectionOverlayColor property to its default value.  
public MethodResetSortIndicatorAscendingImage Resets the property to its default value.  
public MethodResetSortIndicatorDescendingImage Resets the property to its default value.  
public MethodResetSplitterBarHorizontalAppearance Resets the property to its default value.  
public MethodResetSplitterBarVerticalAppearance Resets the property to its default value.  
public MethodResetSummaryButtonImage Resets the property to its default value.  
public MethodResetTabNavigation Resets TabNavigation to its default value (next cell).  
public MethodResetUseFixedHeaders Resets the UseFixedHeaders property to its default value of false.  
public MethodResetUseOptimizedDataResetMode Resets the UseOptimizedDataResetMode property to its default value.  
public MethodResetValueLists Resets valuelists  
public MethodResetViewStyle Resets ViewStyle to its default value (multiband).  
public MethodResetViewStyleBand Reset ViewStyleBand to its default setting (vertical).  
public MethodResolveLayoutAppearance Resolves the appearance of the Layout.  
public MethodSaveOverloaded.  Saves a layout to a stream, including all properties.  
public MethodSaveAsXmlOverloaded.  Saves a layout to a stream, including all properties.  
public MethodShouldSerializeKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
public MethodToString Returns an empty string.  
public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Top

Protected Methods

 NameDescription
protected MethodClearViewStyle Clears the ViewStyle scheme used to render row data.  
protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
protected MethodOnAddedToCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodOnDisposeOverridden.  Called when the object is disposed of  
protected MethodOnObjectPropChangedOverridden.  Overridden. Called when a property has changed.  
protected MethodOnRemovedFromCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodOnSubObjectPropChangedOverridden.  Called when a property has changed on a sub object  
protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodShouldSerializeAddNewBox Returns true if this property is not set to its default value  
protected MethodShouldSerializeAllowCardPrinting Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeAppearance Returns true if this property is not set to its default value  
protected MethodShouldSerializeAppearances Returns true if this property is not set to its default value  
protected MethodShouldSerializeAutoFitColumns Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAutoFitStyle Returns true if this property is not set to its default value.  
protected MethodShouldSerializeBands Returns true if any band has a non default value  
protected MethodShouldSerializeBorderStyle Returns true if this property is not set to its default value  
protected MethodShouldSerializeBorderStyleCaption Returns true if this property is not set to its default value  
protected MethodShouldSerializeCaptionAppearance Returns true if this property is not set to its default value  
protected MethodShouldSerializeCaptionVisible Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeCellHottrackInvalidationStyle Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeClipboardCellDelimiter Returns true if the property needs to be serialized.  
protected MethodShouldSerializeClipboardCellSeparator Returns true if the property needs to be serialized.  
protected MethodShouldSerializeClipboardRowSeparator Returns true if the property needs to be serialized.  
protected MethodShouldSerializeColScrollRegions Returns true if this property is not set to its default value  
protected MethodShouldSerializeColumnChooserEnabled Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeColumnScrollbarSmallChange Returns true if the property has been set to a non-default value.  
protected MethodShouldSerializeEmptyRowSettings Returns true if the property needs to be serialized.  
protected MethodShouldSerializeFilterDropDownButtonImage Returns true if this property is not set to its default value.  
protected MethodShouldSerializeFilterDropDownButtonImageActive Returns true if this property is not set to its default value.  
protected MethodShouldSerializeGroupByBox Returns true if this property is not set to its default value  
protected MethodShouldSerializeInterBandSpacing Returns true if this property is not set to its default value  
protected MethodShouldSerializeLoadStyle Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeMaxBandDepth Returns true if this property is not set to its default value.  
protected MethodShouldSerializeMaxColScrollRegions Returns true if this property is not set to its default value  
protected MethodShouldSerializeMaxRowScrollRegions Returns true if this property is not set to its default value  
protected MethodShouldSerializeNewBandLoadStyle Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeNewColumnLoadStyle Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeOverride Returns true if this property is not set to its default value  
protected MethodShouldSerializePriorityScrolling Returns true if this property is not set to its default value.  
protected MethodShouldSerializeRowConnectorColor Returns true if this property is not set to its default value  
protected MethodShouldSerializeRowConnectorStyle Returns true if this property is not set to its default value.  
protected MethodShouldSerializeRowScrollRegions Returns true if this property is not set to its default value  
protected MethodShouldSerializeRowSelectorImages Returns true if this property is not set to its default value  
protected MethodShouldSerializeScrollbarIntersectionAppearance Returns true if the property needs to be serialized.  
protected MethodShouldSerializeScrollBarLook Indicates whether the property needs to be serialized.  
protected MethodShouldSerializeScrollbars Returns true if this property is not set to its default value  
protected MethodShouldSerializeScrollBounds Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeScrollStyle Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSortIndicatorAscendingImage Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSortIndicatorDescendingImage Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSplitterBarHorizontalAppearance Returns true if the property needs to be serialized.  
protected MethodShouldSerializeSplitterBarVerticalAppearance Returns true if the property needs to be serialized.  
protected MethodShouldSerializeSummaryButtonImage Returns true if this property is not set to its default value.  
protected MethodShouldSerializeTabNavigation Returns true if this property is not set to its default value  
protected MethodShouldSerializeUseFixedHeaders Returns true if the property has been set to a non-default value.  
protected MethodShouldSerializeUseOptimizedDataResetMode Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeValueLists Returns true if this property is not set to its default value  
protected MethodShouldSerializeViewStyle Returns true if this property is not set to its default value  
protected MethodShouldSerializeViewStyleBand Returns true if this property is not set to its default value  
Top

Public Events

 NameDescription
public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Top

See Also