Persistate API documentation
CaptionPosition Structure
NamespacesPersistateCaptionPosition

[This is preliminary documentation and is subject to change.]

This is a multi value struct generated from the caption position data class in the Persistate system definition file.
Declaration Syntax
C#
public struct CaptionPosition : IMultiValue
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
CaptionPosition(Int32)
Creates a new CaptionPosition from an integer value.

_undefined_
This is the default CaptionPosition value.

Above
This is the value for above.

Below
This is the value for below.

CloseAligned
This is the value for close aligned.

Equals(Object)
Performs an equality comparison with another object.
(Overrides ValueType.Equals(Object).)
ExplicitNarrowingExplicitExplicitExplicit(CaptionPosition to String)
Explicit conversion from CaptionPosition to string.

FarAligned
This is the value for far aligned.

Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Creates a hash code for the CaptionPosition.
(Overrides ValueType.GetHashCode()()()().)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
ImplicitWideningImplicitImplicitImplicit(CaptionPosition to Int32)
Implicit conversion from CaptionPosition to int.

ImplicitWideningImplicitImplicitImplicit(Int32 to CaptionPosition)
Implicit conversion from int to CaptionPosition.

ImplicitWideningImplicitImplicitImplicit(String to CaptionPosition)
Implicit conversion from string to CaptionPosition.

IsCombinable
Indicates whether CaptionPosition values can be combined.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ordinal
Contains the value of the CaptionPosition.

Ordinal
Gets the integer ordinal value of this CaptionPosition.

Parse(String)
Parses a string containing a textual representation of an CaptionPosition.

sourcePairs
This array contains one source pair for each CaptionPosition value.

SourcePairs
Gets the array of ISourcePairs holding ordinal and text values.

TopValue
This is the value for the top value.

ToString()()()()
Creates a textual representation of the CaptionPosition.
(Overrides ValueType.ToString()()()().)
Remarks

This provides an enumeration of the possible positions for captions alongside Persistate controls. The possible values are:

CloseAligned
Captions are placed to the left of the control, with a fixed distance between the right hand edge of the caption and the left hand edge of the control.
FarAligned
Captions are placed to the left of the control, with a fixed distance between the left hand edge of the caption and the left hand edge of the control.
Above
Captions are placed above the control, with a fixed distance between the bottom edge of the caption and the top edge of the control.
Below
Captions are placed below the control, with a fixed distance between the top edge of the caption and the bottom edge of the control.


In all cases, the fixed distance mentioned is supplied by the IPCaptionedControl.CaptionDistanceproperty of the control.

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)