Version

UltraGridRow Class Members

The following tables list the members exposed by UltraGridRow.

Protected Fields
 NameDescription
Protected FieldselectedValueThe internal selectedValue state of the item. (Inherited from Infragistics.Win.UltraWinGrid.GridItemBase)
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectReturns the accesible object representing the data area of the grid.  
Public PropertyActivatedOverridden. Indicates whether this is the active row.  
Public PropertyActivationReturns or sets a value that determines how an object will behave when it is activated.  
Public PropertyAllAncestorsExpandedReturns True if this row's parent row and all its ancestors are expanded. This property is read-only.  
Public PropertyAllowFixingSpecifies whether the user is allowed to fix the row. This property disables the user interface for this row. Default value is Default.  
Public PropertyAppearanceReturns or sets the Appearance object that controls the object's formatting.  
Public PropertyAutoPreviewEnabledReturns a value that determines whether the AutoPreview area will be displayed.  
Public PropertyAutoPreviewHeightReturns the height, in pixels, of the AutoPreview area for the row  
Public PropertyAutoPreviewHiddenDetermines if the Description will be displayed in the AutoPreview area for this row. This property is not available at design-time.  
Public PropertyBandOverridden. Returns the UltraGridBand that the object belongs to, if any. This property is read-only at run-time. This property is not available at design-time.  
Public PropertyBorderStyleCellResolvedGets the resolved border style of the cells in this row.  
Public PropertyCardCaptionReturns or sets the text that will be displayed as the card's caption.  
Public PropertyCellAppearanceDetermines the formatting attributes that will be applied to the cells in a row.  
Public PropertyCellsReturns a reference to a collection of UltraGridCell objects. This property is read-only at run-time. This property is not available at design-time.  
Public PropertyChildBandsThe read-only collection of UltraGridChildBand objects that contain the child rows for this row.  
Public PropertyDataChangedReturns a value that determines whether the data in a cell or row has been changed, but not committed to the data source. This property is read-only at run-time. This property is not available at design-time.  
Public PropertyDataErrorInfoAllows getting or setting of IDataErrorInfo data for this UltraGridRow.  
Public PropertyDataErrorInfoResolvedReturns a UltraGridRow.ResolvedUltraGridRowDataErrorInfo object which returns the resolved error information for the row, including teh DataErrorInfo and any IDataErrorInfo information provided by the ListObject.  
Public PropertyDescriptionReturns or sets the text that will be displayed as a description.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyExpandedReturns or sets whether the row is expanded. This property is not available at design-time.  
Public PropertyExpansionIndicatorReturns or sets a value that determines whether row expansion (plus/minus) indicators are displayed.  
Public PropertyFixedGets or sets the fixed state of the row. Setting this property to false unfixes the row if it's fixed and setting it to true fixes the row if it's unfixed. The row is fixed on top or bottom depending on the UltraGridOverride.FixedRowStyle setting.  
Public PropertyFixedHeightReturns or sets a value that determines whether a row can be sized by the user. This property is not available at design-time.  
Public PropertyFixedResolvedGets the actual fixed state of the row. This value can differ from the Fixed property's value in situations where the row is not actually fixed.  
Public PropertyHasAppearanceReturns true if the appearance object has been allocated for the Appearance property.  
Public PropertyHasCellAppearanceReturns true if the appearance object has been allocated for the CellAppearance property.  
Public PropertyHasExpansionIndicatorReturns true if the row should display an expansion indicator  
Public PropertyHasPreviewAppearanceReturns true if the appearance object has been allocated for the PreviewAppearance property.  
Public PropertyHasRowSelectorAppearanceReturns true if the appearance object has been allocated for the RowSelectorAppearance property.  
Public PropertyHeightReturns or sets the height of the row (excluding spacing).  
Public PropertyHiddenDetermines whether the object will be displayed. This property is not available at design-time.  
Public PropertyHiddenResolvedReturns true if the hidden property for this row is set to true or any of this row's ancestor rows have their hidden property set to true.  
Public PropertyIndexThe index of this row in its parent collection  
Public PropertyInInitializeRowEventThis property returns True if the UltraGrid.InitializeRow event is in process for the current row. It will return False outside of InitializeRow.  
Public PropertyIsActiveRowReturns True if the current row is the active row.  
Public PropertyIsAddRowIndicates whether this row is an add-row.  
Public PropertyIsAlternateReturns whether the current row is an alternate row. Alternate rows can have their own appearance settings.  
Public PropertyIsCardReturns whether this row is being displayed in Card View mode. This property is read-only.  
Public PropertyIsCardCompressedIndicates whether the card is compressed or expanded.  
Public PropertyIsDataRowReturns true if the row is associated with a row in the data source. This property returns false for group-by rows, filter rows, template add-rows, summary rows etc...  
Public PropertyIsDeletedReturns True if the row has been deleted but the UltraGridRow object has not yet been destroyed.  
Public PropertyIsEmptyMessageRowIndicates whether the row is an EmptyMessageRow.  
Public PropertyIsEmptyRowReturns true if this row is an instance of UltraGridEmptyRow.  
Public PropertyIsExpandableReturns true if the band's Expandable property is true and the band has child bands that aren't hidden.  
Public PropertyIsExpandedReturns true if the row is expanded in the display.  
Public PropertyIsFilteredOutIndicates whether the row is filtered out or not. A filtered out row is a row that does not pass the filter criteria. Filter criteria can be sepcified by UltraGridBand.ColumnFilters or RowsCollection.ColumnFilters property depending on the UltraGridOverride.RowFilterMode setting.  
Public PropertyIsFilterRowIndicates whether the row is a filter row.  
Public PropertyIsGroupByRowIndicates whether this is a group-by row.  
Public PropertyIsPlaceHolderRowIndicates whether the row is a placeholder row.  
Public PropertyIsStillValidTrue only if this row and all of its ancestor rows are still valid (read-only).  
Public PropertyIsSummaryRowIndicates whether the row is a summary row.  
Public PropertyIsTabStopProperty: Returns true only if tab stop (Inherited from Infragistics.Win.UltraWinGrid.GridItemBase)
Public PropertyIsTemplateAddRowIndicates whether this row is a template add-row.  
Public PropertyIsUnmodifiedTemplateAddRowIndicates whether this row is an add-row that was added via template-add row and hasn't been modified by the user yet. If this property returns true then it won't show any child template add-row.  
Public PropertyListIndexReturns the index corresponding to this row from the IList that the control is bound to. Return value of -1 indicates that a row has been deleted or doesn't exist anymore.  
Public PropertyListObjectReturns the object corresponding to this row from the IList that the control is bound to. Returns Null if this is an UltraGridGroupByRow.  
Public PropertyParentCollectionReturns the rows collection this row belongs to  
Public PropertyParentRowReturns this row's parent row which could be an UltraGridRow instance or an UltraGridGroupByRow instance.  
Public PropertyPreviewAppearanceReturns or sets the Appearance object that controls the formatting of row's AutoPreview area.  
Public PropertyRowEditTemplateGets or sets the template used for editing the row.  
Public PropertyRowEditTemplateResolvedReturns the row's RowEditTemplate, if set; otherwise, returns the template associated with the band.  
Public PropertyRowSelectorAppearanceDetermines how the row selectors will look.  
Public PropertyRowSelectorNumberReturns the number that's going to be displayed in the row selector. Retruns -1 if row selector number style is set to None.  
Public PropertyRowSpacingAfterReturns or sets the amount of spacing (in pixels) rendered before a row.  
Public PropertyRowSpacingAfterResolvedReturns the actual value used for RowSpacingAfter for this row.  
Public PropertyRowSpacingBeforeReturns or sets the amount of spacing (in pixels) rendered before a row.  
Public PropertyRowSpacingBeforeResolvedReturns the actual value used for RowSpacingBefore for this row.  
Public PropertySelectedOverridden. Property: gets/sets whether the row is selected.  
Public PropertyShowAsExpandedReturns true if the Row's expansion indicator indicates that the row is expanded (appears as a minus sign.) This property is read-only.  
Public PropertyStartsNewPrintedPageSpecifies if the row should be the start of a new printed page when printing the grid.

If the band containing the row is displayed using card view then this property has no affect on the printing of the cards.

 
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyToolTipTextSpecifies the tooltip to display when the user hovers the mouse over the header.  
Public PropertyVisibleIndexReturns the index of this row in its parent collection, relative to all other visible rows. Hidden rows are not counted.  
Protected Properties
 NameDescription
Protected PropertyIsRowHeightDirtyReturns true if the row height needs to be re-initialized  
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodActivateActivates row. Returns true if the operation was cancelled.  
Public MethodCancelUpdateCancels the update of the row or cell when data has been changed (similar to pressing ESC).  
Public MethodCollapseAllCollapses every row in the band and discards all of the expand/collapse information for the child rows.  
Public MethodCreateObjRefCreates 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 MethodDeallocateCellsReleases allocated cell objects. Cells are allocated lazily as they are accessed. This method is for releasing cells that have been allocated so for.  
Public MethodDeleteOverloaded. Deletes the row.  
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodExpandAllExpands all rows (and bands, if applicable) in the object. Ignores the existing expanded/collapsed state of any rows or bands.  
Public MethodExpandAncestorsEnsures that all ancestor rows are expanded.  
Public MethodGetCellActivationResolvedReturns the resolved activation of the cell associated with this row and the column.  
Public MethodGetCellSizeResolvedReturns the resolved size of the cell for the specified column in this row.  
Public MethodGetCellTextReturns the text for a cell.  
Public MethodGetCellValueOverloaded. Returns the data value for a cell from the database  
Public MethodGetChildOverloaded. Returns a reference to the first or last child row of a row.  
Public MethodGetEditorResolvedGets the resolved editor for the cell associated with this row and the specified column.  
Public MethodGetExportValueGets the Value of the cell that should be used for exporting.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetSiblingOverloaded. Returns a sibling row (if any exist)  
Public MethodGetUIElementOverloaded. Overridden. Returns the UltraGridUIElement object that is associated with an object.  
Public MethodGetValueListResolvedGets the resolved value list for the cell associated with this row and the specified column.  
Public MethodHasCellOverloaded. Indicates if cell associated with the specified column has been created.  
Public MethodHasChildOverloaded. Returns a Boolean expression indicating whether a row has a child row.  
Public MethodHasNextSiblingOverloaded. Returns a Boolean expression indicating whether a row has a sibling row below it.  
Public MethodHasParentOverloaded. Returns true if the row has a parent row. If the ParentRow is null then returns false.  
Public MethodHasPrevSiblingOverloaded. Returns a Boolean expression indicating whether a row has a sibling row above it.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodMeetsCriteriaOverloaded. Returns true if the row meets the criteria specified by the passed in filter condition.  
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodPerformAutoSizeResizes the row based on its contents.  
Public MethodRefreshOverloaded. Refresh the display and/or refetch the data with or without events.  
Public MethodRefreshFiltersRe-evaluates the filter conditions on this row.  
Public MethodRefreshSortPositionIf the row is not at correct sort position, this method will reposition the row in the rows collection based on the current sort criteria. Also if it's in the wrong group, it will put it under appropriate group by row.  
Public MethodResetAllowFixingResets AllowFixing property to its default value of Default.  
Public MethodResetToolTipTextResets the property to its default value of false.  
Public MethodResolveAppearanceOverloaded. Resolves the row object's appearance and sets the resolved values on the specified appearance data structure.  
Public MethodResolveCellAppearanceOverloaded. Resolves all of a cell's appearance properties  
Public MethodResolveMergedCellAppearanceResolves appearance for the merged cell associated with this cell.  
Public MethodResolveRowSelectorAppearanceOverloaded. Resolves all of the appearance properties for the row selector  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodShowEditTemplateShows the RowEditTemplate associated with the row, if any.  
Public MethodUpdateUpdates the data source with any modified information from the grid.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
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 MethodOnDisposeOverridden. Overridden.  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when a property has changed on a sub object  
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also