Version

RoleState Enumeration

Enumeration indicating the state of role
Syntax
'Declaration
 
Public Enum RoleState 
   Inherits System.Enum
public enum RoleState : System.Enum
Members
MemberDescription
ActiveThe object represents an item with focus
ActiveCellThe object is associated with an ActiveCell.
ActivePreviewPageThis thumbnail page is active in the associated print preview control.
AddRowThis object is part of or associated with an add-row.
AlternateEmptyRowThe object is part of or associated with an alternate empty row.
AlternateItemThis object is part of or associated with an item that's alternate. This is analogous to RowAlternateAppearance of the UltraGrid, and the alternate month appearances of WinSchedule's UltraCalendarLook component.
BusyThe object is busy, waiting for something.
CardViewThe object is in card-view mode.
CheckedCheck state of checked.
CollapsedThe object is in collapsed state. Note that this state applies to only select few roles. Most roles support only the Expanded state, and not this state.
DataErrorThe object currently has data error. This typically applies to a cell.
DragOverSomething is being dragged over the object
EditModeThe object is currently in edit mode
EmptyRowThe object is part of or associated with an empty row.
ExpandedThis object is expanded.
FilteredInThe object is part of or associated with a row that passed filter criteria when using filter row functionality.
FilteredOutThe object is part of or associated with a row that did not pass filter criteria when using filter row functionality.
FilterRowThe object is part of or associated with a filter row.
FixedColumnThis object is part of or associated with a fixed column. See grid's fixed column functionality.
FixedRowThis object is part of or associated with a fixed row. See grid's fixed row functionality.
FloatingThis object is on a floating window.
FocusedThe associated control is focused.
FormulaErrorThe object currently has formula error. This typically applies to cells of a formula column.
GroupByColumnThis object is part of or associated with a group-by column.
GroupByRowThis object is part of or associated with a group-by row.
HasActiveFiltersThis state applies to filter row and filter cell that has active filter conditions.
HasActivityThis object has activity, for example, a day with appointments, notes or holidays in WinSchedule.
HorizontalThis object is in a horizontal orientation.
HotTrackedThe mouse is currently over the object
HotTrackedIndirectlyThe object is not HotTracked directly, but is HotTracked because it is associated with another item which is HotTracked.
HotTrackedPressedThe object is hottracked while being pressed.
HotTrackExpandedThe object is expanded and the mouse is currently over it.
HotTrackSelectedThe object is selected and the mouse is currently over it.
IndeterminateCheck state of Indeterminate.
MergedCellThis object is part of or associated with a merged cell.
NormalThe object is in its default state
PressedThe object is currently pressed
PressedSelectedThe object is selected but still pressed.
ReadOnlyThe editor is read-only.
RecentlyUsedThis object has been recently used.
RowHotTrackedThis object is part of or associated with a row that's currently hot-tracked.
SelectedThe object is selected
SelectedCellThe object is associated with a selected cell.
TemplateAddRowThis object is part of or associated with a template add-row.
UncheckedCheck state of unchecked.
VerticalThis object is in a vertical orientation.
VisitedLinkThis state represents a link that has already been visibled.
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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