Back to Devexpress

BarDockInfo Members

wpf-devexpress-dot-xpf-dot-bars-dot-bardockinfo-dot-underscore-members.md

latest16.4 KB
Original Source

BarDockInfo Members

Contains information on the dock position of a bar.

Constructors

NameDescription
BarDockInfo()Initializes a new instance of the BarDockInfo class.
BarDockInfo(Bar)Initializes a new instance of the BarDockInfo class with the specified bar.

Fields

NameDescription
BarProperty staticIdentifies the BarDockInfo.Bar dependency property.
ColumnProperty staticIdentifies the BarDockInfo.Column dependency property.
ContainerNameProperty staticIdentifies the BarDockInfo.ContainerName dependency property.
ContainerProperty staticIdentifies the BarDockInfo.Container dependency property.
ContainerTypeProperty staticIdentifies the BarDockInfo.ContainerType dependency property.
FloatBarOffsetProperty staticIdentifies the BarDockInfo.FloatBarOffset dependency property.
FloatBarWidthProperty staticIdentifies the BarDockInfo.FloatBarWidth dependency property.
FloatingContainerNameReturns the name of a floating BarContainerControl that contains the current bar.
IsFloatingProperty staticIdentifies the BarDockInfo.IsFloating dependency property.
OffsetProperty staticIdentifies the BarDockInfo.Offset dependency property.
RowProperty staticIdentifies the BarDockInfo.Row dependency property.
ShowHeaderInFloatBarProperty staticIdentifies the BarDockInfo.ShowHeaderInFloatBar dependency property.

Properties

NameDescription
Bar

Gets or sets a bar that owns the current object. This is a dependency property.

| | BarRect | Gets the rectangle occupied by the bar. | | Column |

Gets or sets the bar’s zero-based column index, which defines the bar’s horizontal position among other bars displayed in the same row. This is a dependency property.

| | Container |

Gets or sets the container that displays the current bar. This is a dependency property.

| | ContainerName |

Gets or sets the name of the container that displays the current bar. This is a dependency property.

| | ContainerType |

Gets or sets the type of container that displays the current bar. This value matches the BarContainerControl.ContainerType property. This is a dependency property.

| | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject. | | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject. | | FloatBarOffset |

Gets or sets the offset of the bar when it’s in the floating state. This is a dependency property.

| | FloatBarWidth |

Gets or sets the bar’s width when it’s in the floating state. This is a dependency property.

| | IsFloating | This member supports the internal infrastructure, and is not intended to be used directly from your code. To specify whether the current bar should be floating, use the BarDockInfo.ContainerType property instead. | | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject. | | Offset |

Gets or sets the bar’s offset from the left or top border of the bar container, based on the container’s orientation. This property is in effect when the bar is docked to a container. This is a dependency property.

| | Row |

Gets or sets the bar’s zero-based row index, which defines the bar’s vertical position among other bars within the bar container. This is a dependency property.

| | ShowCloseButtonInFloatBar |

Gets whether a close (‘x’) button is displayed within a bar, when it’s floating. This is a dependency property.

| | ShowHeaderInFloatBar |

Gets or sets whether to display a title for a bar when it’s floating. This is a dependency property.

|

Methods

NameDescription
CheckAccess()Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
CoerceValue(DependencyProperty)Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
GetHashCode()Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator()Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType()Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty)Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InvalidateProperty(DependencyProperty)Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReadLocalValue(DependencyProperty)Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reset()Resets the current object’s settings (BarDockInfo.Container, BarDockInfo.Row, BarDockInfo.Column and BarDockInfo.Offset).
Reset(Boolean)Resets all BarDockInfo settings to their default values.
SetCurrentValue(DependencyProperty, Object)Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protectedReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ToString()Returns a string that represents the current object. Inherited from Object.
VerifyAccess()Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.

Events

NameDescription
ContainerTypeChangedFires in response to changing the BarDockInfo.ContainerType property’s value.
WeakContainerTypeChangedThis member supports the internal infrastructure, and is not intended to be used directly from your code.

See Also

BarDockInfo Class

DevExpress.Xpf.Bars Namespace