Version

UltraGridColumn Class Properties

For a list of all members of this type, see UltraGridColumn members.

Public Properties
 NameDescription
Public PropertyAllowGroupByDetermines whether this column can be dragged into the GroupByBox to become a GroupBy column. The Default is resolved to True.  
Public PropertyAllowRowFilteringSet this to False to explicitly disable row filtering on this column.  
Public PropertyAllowRowSummariesIndicates whether to allow the user to be able to specify a summary for this column.  
Public PropertyAutoCompleteModeGets/sets the mode for automatic completion of text typed in the edit portion.  
Public PropertyAutoCompleteModeResolvedReturns the resolved value of the AutoCompleteMode property.  
Public PropertyAutoEditModeReturns or sets whether pressing a key automatically enters edit mode on the active cell.  
Public PropertyAutoSizeEditDetermines if the column will allow auto-expanding pop-up edit windows.  
Public PropertyAutoSizeModeSpecifies column autosizing mode. If UltraGridOverride.AllowColSizing is set to None, then this is ignored.  
Public PropertyAutoSuggestFilterModeGets/sets a value which determines the the filtering criteria for items which appear in the dropdown that is displayed when the AutoCompleteMode property is set to 'Suggest' or 'SuggestAppend'.  
Public PropertyAutoSuggestFilterModeResolvedReturns the resolved value of the AutoSuggestFilterMode property.  
Public PropertyBandReturns the associated Band object.  
Public PropertyButtonDisplayStyleReturns or sets a value that determines how cell buttons are displayed for a column's cells.  
Public PropertyCaseReturns or sets the case to use when editing or displaying column text.  
Public PropertyCellActivationReturns or sets a value that determines how an object will behave when it is activated.  
Public PropertyCellAppearanceDetermines the formatting attributes that will be applied to the cells in a band or the grid. Infragistics.Win.Appearance  
Public PropertyCellButtonAppearanceDetermines the formatting attributes that will be applied to the buttons in the cells of this column.  
Public PropertyCellClickActionReturns or sets a value that indicates what will occur when a cell is clicked.  
Public PropertyCellDisplayStyleCellDisplayStyle specifies how the cells get rendered. You can use this property to speed up rendering of cells by setting it to FormattedText or PlainText. Default is resolved to FullEditorDisplay.  
Public PropertyCellMultiLineDetermines if the cell's data should be displayed in a multi-line format.  
Public PropertyCellSizeResolvedResolved cell size. This property returns the actual width and the height of the cells associated with the column.  
Public PropertyCharacterCasingReturns or sets the case to use when editing or displaying column text.  
Public PropertyColSpanReturns or sets a value that determines the number of columns to skip when synchronizing columns across multiple bands.  
Public PropertyColumnChooserCaptionThe caption displayed in the column’s header in the column chooser. Default is resolved to the column header’s Caption.  
Public PropertyCustomFilterDialogCaptionThe caption displayed in the custom filter dialog for this column.  
Public PropertyDataTypeReturns the column's underlying data type. This property is read-only for bound columns.  
Public PropertyDefaultCellValueGets or sets the default cell value that will be assigned when new rows are added via the add-row feature or the add-new box.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorGets or sets the editor that this column will use for editing and displaying cells. By default or when it's assigned null it will get the editor from the EditorControl property.  
Public PropertyEditorComponentComponent that implements IProvidesEmbeddableEditor. Attempt to set a component that does not implement IProvidesEmbeddableEditor interface will cause an exception.  
Public PropertyExcludeFromColumnChooserForces the column to be excluded from the column chooser control. This also specifies whether the user can unhide the column.  
Public PropertyFilterCellAppearanceDetermines the formatting attributes that will be applied to the associated cells in filter rows.  
Public PropertyFilterClearButtonVisibleSpecifies whether to display the filter clear button in the filter cells fo this column. Default is resolved to True.  
Public PropertyFilterComparisonStyleGets/Sets type of grid filter comparison style  
Public PropertyFilterComparisonTypeSpecifies whether the filtering is performed case-sensitive. Default is to perform filtering case-insensitive.  
Public PropertyFilterEvaluationTriggerSpecifies when the filter input into filter row cells is applied.  
Public PropertyFilterOperandDropDownItemsGets or sets the items that will be displayed by the grid when showing a dropdown filter list.  
Public PropertyFilterOperandStyleSpecifies the style of operand input in the filter row cells. Default is be resolved to UseColumnEditor for DateTime and Boolean columns and Combo for other types of columns. This can be overridden on each column using the column's FilterOperandStyle property.  
Public PropertyFilterOperatorAppearanceDetermines the formatting attributes that will be applied to the associated operator indicators in filter rows.  
Public PropertyFilterOperatorDefaultValueSpecifies the default value of the operator cells in the filter row. If operator cells are hidden, this is used as the filter operator for values entered in the associated filter operand cells. This can be overridden on each column. Default is resolved to Equals for DateTime and Boolean columns and StartsWith for other column types.  
Public PropertyFilterOperatorDropDownItemsSpecifies which operators to list in the operator drop down in filter rows. Default is resolved to a value that is based on the column's data type.  
Public PropertyFilterOperatorLocationSpecifies the style of operator input in the filter row cells. Default is resolved to WithOperand.  
Public PropertyFormatReturns or sets a string used to control the formatting of displayed text.  
Public PropertyFormatInfoGets or sets the culture specific information used to determine how values are formatted.  
Public PropertyFormulaSpecifies the formula. UltraGridBase.CalcManager property must be set to a valid instance of Infragistics.Win.CalcEngine.IUltraCalcManager for this property to have any affect.  
Public PropertyFormulaAbsoluteNameReturns the absolute name of the column that you can use to refer to it in formulas.  
Public PropertyFormulaDialogReferenceNodeReturns null.  
Public PropertyFormulaErrorAppearanceDetermines the formatting attributes that will be applied to the cells containing formula errors.  
Public PropertyFormulaErrorValueSpecifies the value to assign to the data source if the column’s formula evaluates to an error. If the column doesn’t have Formula set, this property is ignored.  
Public PropertyFormulaValueConverterInterface for providing custom logic for converting formula results and the formula source values.  
Public PropertyGroupReturns or sets the UltraGridGroup object that the column is associated with. This property is not available at design-time.  
Public PropertyGroupByComparerProperty used for specifying a custom comparer to sort group-by rows.  
Public PropertyGroupByEvaluatorProperty used to perform non-default group by comparisons.  
Public PropertyGroupByModeGets/sets the setting which determines how the values in this column will be grouped when using the 'OutlookGroupBy' setting for UltraGridLayout.ViewStyleBand.  
Public PropertyGroupByRowAppearanceGets or sets the default appearance of all the GroupByRows associated with this column.  
Public PropertyGroupByRowConnectorAppearanceDetermines the appearance of the area that exists to the left of the child rows of a GroupByRow.  
Public PropertyGroupResolvedReturns the group which contains the column.  
Public PropertyHasCellAppearanceReturns true if an CellAppearance object has been created.  
Public PropertyHasCellButtonAppearanceReturns true if an CellButtonAppearance object has been created.  
Public PropertyHasMaskLiteralsAppearanceReturns true if an CellAppearance object has been created.  
Public PropertyHeaderReturns the Header object associated with the column. This property is read-only at run-time. This property is not available at design-time.  
Public PropertyHiddenDetermines whether the object will be displayed. This property is not available at design-time.  
Public PropertyHiddenResolvedUnlike the Hidden property, this property takes into account whether the column is in a hidden group, or if the band is displaying groups and the column is not in any group.  
Public PropertyHiddenWhenGroupByDetermines if this column will be hidden when it is a groupby column. By default groupby columns are hidden.  
Public PropertyHiddenWhenParentGroupCollapsedDetermines if this column will be hidden when it's parent group is collapsed. 'Group' in this case refers to colunn grouping or UltraGridGroup and should not be confused with OutlookParentGroupCollapsed which affects the grouping of rows.  
Public PropertyIgnoreMultiCellOperationSpecifies whether to ignore multi-cell operations on cells of this column. Default value of the property is Default which is resolved to False. If set to True, any multi cell operations that will end up modifying the cell values will be ignored for the cells associated with this column.  
Public PropertyImeModeSpecifies the IME mode for the column.  
Public PropertyIndexThe index of this column in the band's column collection  
Public PropertyInitialSortDirectionGets or sets the initial sort direction.  
Public PropertyInvalidValueBehaviorSpecifies behavior when the user attempts to leave a cell after entering an invalid value.  
Public PropertyIsBoundIndicators whether this is a bound or unbound column. This property is read-only.  
Public PropertyIsChapteredReturns true if this is a chaptered column (represents a child set of rows)  
Public PropertyIsCloneGets if the column being accessed is a clone or not.  
Public PropertyIsFirstVisibleColumnOnLevelReturns true if this is the first visible column on this level. Note: Multiple levels are only supported within groups.  
Public PropertyIsGroupByColumnIndicates whether rows are grouped by this column or not. (Whether this is a group by column or not).  
Public PropertyIsReadOnlyReturns whether the column is read only (based on its bindings)  
Public PropertyIsVisibleInLayoutIndicates whether this column is visible in row-layout mode.  
Public PropertyKeyOverridden. Returns or sets a value that uniquely identifies an object in a collection.  
Public PropertyLayoutReturns the UltraGridLayout object that determines the layout of the object. This property is read-only at run-time.  
Public PropertyLevelReturns or sets the level of a band in which a column resides.  
Public PropertyLockedWidthDetermines if the width of the column can be changed by the user.  
Public PropertyMaskClipModeReturns or sets a value that determines how cell values for a column will be copied to the clipboard when data masking is in enabled.  
Public PropertyMaskDataModeReturns or sets a value that determines how cell values for a column will be stored by the data source when data masking is enabled.  
Public PropertyMaskDisplayModeReturns or sets a value that determines cell values will be displayed when the cells are not in edit mode and data masking is enabled.  
Public PropertyMaskInputReturns or sets the input mask associated with the masked edit control.  
Public PropertyMaskLiteralsAppearanceIf the cell has MaskInput set or is using a UltraMaskedEdit control then this appearance will be applied to the literal chars while in edit mode.  
Public PropertyMaxLengthReturns or sets the maximum length of the text that can be entered into a cell. Zero indicates that there is no limit.  
Public PropertyMaxValueSpecifies the maximum value that can be entered in the cell. Default value is null meaning no maximum constraint. The object assigned to this property should be the same type as the column's DataType or compatible otherwise it won't be honored.  
Public PropertyMaxValueExclusiveGets/sets the first value greater than the maximum value that can be entered in the cell. Default value is null (Nothing) meaning no maximum constraint. The object assigned to this property should be the same type as the column's DataType or compatible otherwise it won't be honored.  
Public PropertyMaxWidthReturns or sets the maximum width of the object in container units.  
Public PropertyMergedCellAppearanceDetermines the formatting attributes that will be applied to the merged cells.  
Public PropertyMergedCellContentAreaSpecifies whether to position the contents of a merged cell in the entire area of the merged cell or just the visible area of the merged cell. Default is resolved to VirtualRect.  
Public PropertyMergedCellEvaluationTypeSpecifies whether to merge cells based on their values or display text.  
Public PropertyMergedCellEvaluatorUsed for specifying custom logic for determining which cells should merge.  
Public PropertyMergedCellStyleSpecifies if and how cell merging is performed. Default is resolved to Never.  
Public PropertyMinLengthGets/sets the minimum length of the text that can be entered into a cell. The default value is 0.  
Public PropertyMinValueSpecifies the minimum value that can be entered in the cell. Default value is null meaning no minimum constraint. The object assigned to this property should be the same type as the column's DataType or compatible otherwise it won't be honored.  
Public PropertyMinValueExclusiveGets/sets the first value less than the minimum value that can be entered in the cell. Default value is null (Nothing) meaning no maximum constraint. The object assigned to this property should be the same type as the column's DataType or compatible otherwise it won't be honored.  
Public PropertyMinWidthReturns or sets the minimum width for a column.  
Public PropertyNullableDetermines how the control stores null or empty data in the database.  
Public PropertyNullTextReturns or sets the string displayed in cells with null values.  
Public PropertyNullTextResolvedReturns the string that will actually be used for cells that are null in this column..  
Public PropertyPadCharDetermines the pad character used for formatting text with mask.  
Public PropertyPromptCharReturns or sets a value that determines the prompt character used during masked input.  
Public PropertyPropertyDescriptorThe property descriptor is used for data binding  
Public PropertyProportionalResizeDetermines adjustment of column width when a group is resized.  
Public PropertyRegexPatternGets/sets a regular expression to which the cell values must conform. All of the characters in the cell's text must be a part of the match for validation to succeed.  
Public PropertyReserveSortIndicatorSpaceWhenAutoSizingGets or sets the value indicating when to reserve space for the sort indicator during an auto-size operation.  
Public PropertyReserveSortIndicatorSpaceWhenAutoSizingResolvedGets the resolved value of ReserveSortIndicatorSpaceWhenAutoSizing.  
Public PropertyRowFilterComparerComparer used to evaluate comparison operators for the row filtering functionality. The values passed in the Compare method of the IComparer will be the two values that are to be compareed.  
Public PropertyRowLayoutColumnInfoGets the instance of RowLayoutColumnInfo associated with this column.  
Public PropertyShowCalculatingTextSpecifies whether cells or summaries in the column will display "#Calculating" in when calculating with an UltraCalcManager.  
Public PropertySortComparerProperty used to perform custom sort comparisons when sorting rows by this column. The values passed in the Compare method of the IComparer will be two UltraGridCell objects.  
Public PropertySortComparisonTypeGets/sets the type of sorting which will be performed the column. Note, this setting can be set for all columns via the SortComparisonType property on the Override object.  
Public PropertySortIndicatorReturns or sets a value that indicates the sorted order of the column.  
Public PropertySpellCheckerGets/sets the component that will perform spell checking on this control.  
Public PropertyStyleDetermines the style of the column.  
Public PropertySupportDataErrorInfoSpecifies whether to make use of IDataErrorInfo interface implemented on the underlying row objects to display error info in the associated cells.  
Public PropertyTabIndexUsed for specifying the order the UltraGrid traverses the cells when tabbing. Default value is -1.  
Public PropertyTabStopDetermines if the cells in the column can get focus when tabbing through the columns.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTipStyleCellReturns or sets a value that determines whether a tip will be displayed when the mouse pauses over a cell.  
Public PropertyUseEditorMaskSettingsSpecifies whether to use the editor's mask related settings rather than the column's mask settings. Default value of this property is false.  
Public PropertyValueBasedAppearanceGets/sets the Infragistics.Win.IValueAppearance object that will be used to apply condition-based appearance resolution.  
Public PropertyValueListReturns a reference to a ValueList object containing the list of values used by a column. This property is not available at design-time.  
Public PropertyVertScrollBarReturns or sets a value that determines if a vertical scrollbar is displayed in a multiline cell.  
Public PropertyWidthDetermines the width of the column.  
Protected Properties
 NameDescription
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
See Also