Class
HorizontalPosition

Defines horizontal positioning for a floating shape using either offset or alignment relative to a reference point.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model.Shapes

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class HorizontalPosition

Inheritance: objectHorizontalPosition

Constructors

HorizontalPosition()

Creates a new horizontal position with default settings (column-relative, zero offset).

Declaration

cs-api-definition
public HorizontalPosition()

HorizontalPosition(HorizontalRelativeFrom, RelativeHorizontalAlignment)

Creates a new horizontal position using alignment (left, center, right, etc.) relative to the specified reference point.

Declaration

cs-api-definition
public HorizontalPosition(HorizontalRelativeFrom relativeFrom, RelativeHorizontalAlignment alignment)

Parameters

relativeFrom

HorizontalRelativeFrom

The relative from.

alignment

RelativeHorizontalAlignment

The alignment.

HorizontalPosition(HorizontalRelativeFrom, double)

Creates a new horizontal position using a numeric offset from the specified reference point.

Declaration

cs-api-definition
public HorizontalPosition(HorizontalRelativeFrom relativeFrom, double offset)

Parameters

relativeFrom

HorizontalRelativeFrom

The relative from.

offset

double

The offset.

Properties

Alignment

Gets or sets the alignment value used when the position type is alignment.

Declaration

cs-api-definition
public RelativeHorizontalAlignment Alignment { get; set; }

Property Value

RelativeHorizontalAlignment

The alignment.

Offset

Gets or sets the numeric offset in device-independent pixels used when the position type is offset.

Declaration

cs-api-definition
public double Offset { get; set; }

Property Value

double

The offset.

RelativeFrom

Gets or sets the reference point (page, margin, column, or character) from which the position is calculated.

Declaration

cs-api-definition
public HorizontalRelativeFrom RelativeFrom { get; set; }

Property Value

HorizontalRelativeFrom

The horizontal relative from value.

ValueType

Gets or sets whether the position uses offset or alignment mode.

Declaration

cs-api-definition
public PositionValueType ValueType { get; set; }

Property Value

PositionValueType

The type of the positioning.

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()