Class DataGridColumnDisplayState
Provides information about the position of a column.
Implements
Namespace: Sartorius.SAF.Presentation.Controls
Assembly: Sartorius.SAF.Presentation.Controls.dll
Syntax
public sealed class DataGridColumnDisplayState : INotifyPropertyChanged
Remarks
GetHashCode() mutates with ColumnIndex, RowIndex and Index. Do not put a DataGridColumnDisplayState into a Hashtable or use as a Key in a dictionary unless you react to this mutation and update buckets of hash tables or dictionaries.
Constructors
View SourceDataGridColumnDisplayState()
Initializes a new instance of the DataGridColumnDisplayState class.
Declaration
public DataGridColumnDisplayState()
Remarks
Index, ColumnIndex and RowIndex default to -1.
Fields
View SourceDisplayStateProperty
Identifies the DependencyProperty for GetDisplayState(DependencyObject).
Declaration
public static readonly DependencyProperty DisplayStateProperty
Field Value
| Type | Description |
|---|---|
| DependencyProperty |
Properties
View SourceColumnIndex
Gets or sets the display column index.
Declaration
public int ColumnIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Edge
Gets or sets the edge the position is relative to.
Declaration
public Edge Edge { get; set; }
Property Value
| Type | Description |
|---|---|
| Edge |
Index
Gets or sets the display index.
Declaration
public int Index { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
This is the index that is given by ColumnIndex and RowIndex. It will equal the DisplayIndex of the column.
RowIndex
Gets or sets the display row index.
Declaration
public int RowIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Methods
View SourceEquals(object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| bool | true if the specified object is equal to the current object; otherwise, false. |
Overrides
View SourceGetDisplayState(DependencyObject)
Gets the display state from an element.
Declaration
public static DataGridColumnDisplayState GetDisplayState(DependencyObject element)
Parameters
| Type | Name | Description |
|---|---|---|
| DependencyObject | element | The element to get the attached property DisplayState from. |
Returns
| Type | Description |
|---|---|
| DataGridColumnDisplayState | The current DataGridColumnDisplayState for the element. |
GetDisplayStateCopy(DependencyObject)
Gets a copy of the current display state.
Declaration
public static DataGridColumnDisplayState GetDisplayStateCopy(DependencyObject element)
Parameters
| Type | Name | Description |
|---|---|---|
| DependencyObject | element | The element to get a copy of the attached property DisplayState from. |
Returns
| Type | Description |
|---|---|
| DataGridColumnDisplayState | A copy of the current DataGridColumnDisplayState for the element. |
GetHashCode()
Serves as a hash function for a particular type.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | A hash code for the current object. |
Overrides
Events
View SourcePropertyChanged
Occurs when a property value changes.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
| Type | Description |
|---|---|
| PropertyChangedEventHandler |
Operators
View Sourceoperator ==(DataGridColumnDisplayState, DataGridColumnDisplayState)
Test for equality
Declaration
public static bool operator ==(DataGridColumnDisplayState a, DataGridColumnDisplayState b)
Parameters
| Type | Name | Description |
|---|---|---|
| DataGridColumnDisplayState | a | The first DataGridColumnDisplayState to check. |
| DataGridColumnDisplayState | b | The other DataGridColumnDisplayState to check. |
Returns
| Type | Description |
|---|---|
| bool |
|
operator !=(DataGridColumnDisplayState, DataGridColumnDisplayState)
Test for inequality.
Declaration
public static bool operator !=(DataGridColumnDisplayState a, DataGridColumnDisplayState b)
Parameters
| Type | Name | Description |
|---|---|---|
| DataGridColumnDisplayState | a | The first DataGridColumnDisplayState to check. |
| DataGridColumnDisplayState | b | The other DataGridColumnDisplayState to check. |
Returns
| Type | Description |
|---|---|
| bool |
|