SplitterDistance Structure

DevZest WPF Docking

SplitterDistance Structure
Represents the size of SplitContainer resizable areas.

Namespace: DevZest.Windows
Assembly: DevZest.WpfDocking (in DevZest.WpfDocking.dll) Version: 2.5.0.0 (2.5.5912.0)
Syntax
[TypeConverterAttribute(typeof(SplitterDistanceConverter))]
public struct SplitterDistance : IEquatable<SplitterDistance>
<TypeConverterAttribute(GetType(SplitterDistanceConverter))>
Public Structure SplitterDistance
	Implements IEquatable(Of SplitterDistance)

The SplitterDistance type exposes the following members.

Constructors
  NameDescription
Public methodSplitterDistance(Double)
Initializes a new instance of the SplitterDistance class.
Public methodSplitterDistance(Double, SplitterUnitType)
Initializes a new instance of the SplitterDistance class.
Top
Properties
  NameDescription
Public propertyStatic memberAutoPixel
Gets an instance of SplitterDistance that holds a value whose size is determined by the size of the content object, and expressed in pixels.
Public propertyStatic memberAutoStar
Gets an instance of SplitterDistance that holds a value whose size is determined by the size of the content object, and expressed as a weighted proportion of available space.
Public propertyIsAbsolute
Gets a value that indicates whether the SplitterDistance holds a value that is expressed in pixels.
Public propertyIsAuto
Gets a value that indicates whether the SplitterDistance holds a value whose size is determined by the size properties of the content object.
Public propertyIsAutoPixel
Gets a value that indicates whether the SplitterDistance holds a value whose size is determined by the size properties of the content object, and expressed in pixels.
Public propertyIsAutoStar
Gets a value that indicates whether the SplitterDistance holds a value whose size is determined by the desired size of the content object, and expressed as a weighted proportion of available space.
Public propertyIsStar
Gets a value that indicates whether the SplitterDistance holds a value that is expressed as a weighted proportion of available space.
Public propertyUnitType
Gets the associated SplitterUnitType for the SplitterDistance.
Public propertyValue
Gets a Double that represents the value of the SplitterDistance.
Top
Remarks

When Value property is NaN, it represents auto sizing: the actual size will be determined by the content's desired size. When UnitType property is Star, the size will be calculated based on weighted proportion of available space.

The SplitterDistance value can have following values in XAML ("?" represents a double value):

"Auto": Auto size in pixel. The subsequent resizing by mouse drog or arrow key will result in a Pixel type value.
"Auto*": Auto size in weighted proportion. The subsequent resizing by mouse drog or arrow key will result in a Star type value.
"*": Equals "1*".
"?*": Weighted proportion: resultSize = totalAvailableSize * ? / (? + 1).
"?": Equals "?px".
"?px": ? device-independent units (1/96th inch per unit).
"?in": ? inch; 1in==96px.
"?cm": ? centimeters; 1cm==(96/2.54)px.
"?pt": ? points; 1pt==(96/72)px.
See Also