VerticalPosition Struct

Namespace:: GemBox.Document

Assembly:: GemBox.Document.dll

Represents a vertical positioning which can be expressed with VerticalPositionType enumeration or System.Double value.

C#
VB.NET

public struct VerticalPosition : IEquatable<VerticalPosition>

Public Structure VerticalPosition
    Implements IEquatable(Of VerticalPosition)

Implements

System.IEquatable<VerticalPosition>

Constructors

VerticalPosition(VerticalPositionType, VerticalPositionAnchor)

Initializes a new instance of the VerticalPosition struct with specified alignment.

C#
VB.NET

public VerticalPosition(VerticalPositionType alignment, VerticalPositionAnchor relativeTo)

Public Sub New(alignment As VerticalPositionType, relativeTo As VerticalPositionAnchor)

Parameters

alignment: VerticalPositionType

The alignment relative to VerticalPositionAnchor specified by relativeTo parameter.

relativeTo: VerticalPositionAnchor

The location from which alignment parameter is relative to.

VerticalPosition(Double, LengthUnit, VerticalPositionAnchor)

Initializes a new instance of the VerticalPosition struct with specified absolute position.

C#
VB.NET

public VerticalPosition(double absolutePosition, LengthUnit unit, VerticalPositionAnchor below)

Public Sub New(absolutePosition As Double, unit As LengthUnit, below As VerticalPositionAnchor)

Parameters

absolutePosition: System.Double

The absolute position in units specified by unit parameter in direction below of the location specified by below parameter.

unit: LengthUnit

The measurement unit for absolute position value.

below: VerticalPositionAnchor

The location from which absolute position is offset from. If absolutePosition parameter is positive, offset is below of VerticalPositionAnchor specified by below parameter, otherwise offset is above.

Properties

PositionType

Gets the vertical position type which can either be absolute or relative.

C#
VB.NET

public readonly VerticalPositionType PositionType { get; }

Public ReadOnly Property PositionType As VerticalPositionType

Property Value

VerticalPositionType

The vertical position type which can either be absolute or relative.

RelativeTo

Gets the base location of this vertical position.

C#
VB.NET

public readonly VerticalPositionAnchor RelativeTo { get; }

Public ReadOnly Property RelativeTo As VerticalPositionAnchor

Property Value

VerticalPositionAnchor

The base location of this vertical position.

Value

Gets the vertical position absolute value in points if PositionType is Absolute, otherwise value is not applicable.

C#
VB.NET

public readonly double Value { get; }

Public ReadOnly Property Value As Double

Property Value

System.Double

The vertical position absolute value in points if PositionType is Absolute, otherwise value is not applicable.

Methods

Equals(VerticalPosition)

Determines whether the other VerticalPosition is equal to this VerticalPosition instance.

C#
VB.NET

public bool Equals(VerticalPosition other)

Public Function Equals(other As VerticalPosition) As Boolean

Parameters

other: VerticalPosition

The other vertical position to compare with this vertical position instance.

Returns

System.Boolean

true if the other VerticalPosition is equal to this VerticalPosition instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this VerticalPosition instance.

C#
VB.NET

public override bool Equals(object obj)

Public Overrides Function Equals(obj As Object) As Boolean

Parameters

obj: System.Object

The System.Object to compare with this vertical position instance.

Returns

System.Boolean

true if the specified System.Object is a VerticalPosition and is equal to this VerticalPosition instance; otherwise, false.

Overrides

System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this VerticalPosition instance.

C#
VB.NET

public override int GetHashCode()

Public Overrides Function GetHashCode As Integer

Returns

System.Int32

An integer value that specifies a hash value for this VerticalPosition instance.

Overrides

System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this VerticalPosition instance.

C#
VB.NET

public override string ToString()

Public Overrides Function ToString As String

Returns

System.String

A System.String that represents this VerticalPosition instance.

Overrides

System.ValueType.ToString()

Operators

Equality(VerticalPosition, VerticalPosition)

Determines whether first and second VerticalPositions are equal.

C#
VB.NET

public static bool operator ==(VerticalPosition first, VerticalPosition second)

Public Shared Operator =(first As VerticalPosition, second As VerticalPosition) As Boolean

Parameters

first: VerticalPosition

The first vertical position.

second: VerticalPosition

The second vertical position.

Returns

System.Boolean

true if first and second vertical positions are equal; otherwise, false.

Inequality(VerticalPosition, VerticalPosition)

Determines whether first and second VerticalPositions are not equal.

C#
VB.NET

public static bool operator !=(VerticalPosition first, VerticalPosition second)

Public Shared Operator <>(first As VerticalPosition, second As VerticalPosition) As Boolean

Parameters

first: VerticalPosition

The first vertical position.

second: VerticalPosition

The second vertical position.

Returns

System.Boolean

true if first and second vertical positions are not equal; otherwise, false.

Implements

System.IEquatable<T>