Figure.HorizontalOffset Property

Reference

Definition

Namespace:: System.Windows.Documents

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value that indicates the distance that a Figure is offset from its baseline in the horizontal direction.

public:
 property double HorizontalOffset { double get(); void set(double value); };

[System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))]
public double HorizontalOffset { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))>]
member this.HorizontalOffset : double with get, set

Public Property HorizontalOffset As Double

Property Value

Double

The distance that a Figure is offset from its baseline in the horizontal direction, in device independent pixels.

The default value is 0.0.

Attributes: TypeConverterAttribute

Examples

The following example shows how to set the HorizontalOffset attribute of a Figure element.

XAML

<FlowDocument>
  <Paragraph>
    <Figure
      Name="myFigure"              
      Width="140" Height="50" 
      HorizontalAnchor="PageCenter"
      VerticalAnchor="PageCenter"
      HorizontalOffset="100" 
      VerticalOffset="20" 
      WrapDirection="Both"
      />
  </Paragraph>
</FlowDocument>

The following example shows how to set the HorizontalOffset property programmatically.

Figure figx = new Figure();
figx.Name = "myFigure";
figx.Width = new FigureLength(140);
figx.Height = new FigureLength(50);
figx.HorizontalAnchor = FigureHorizontalAnchor.PageCenter;
figx.VerticalAnchor = FigureVerticalAnchor.PageCenter;
figx.HorizontalOffset = 100;
figx.VerticalOffset = 20;
figx.WrapDirection = WrapDirection.Both;

Paragraph parx = new Paragraph(figx);
FlowDocument flowDoc = new FlowDocument(parx);

Dim figx As New Figure()
With figx
    .Name = "myFigure"
    .Width = New FigureLength(140)
    .Height = New FigureLength(50)
    .HorizontalAnchor = FigureHorizontalAnchor.PageCenter
    .VerticalAnchor = FigureVerticalAnchor.PageCenter
    .HorizontalOffset = 100
    .VerticalOffset = 20
    .WrapDirection = WrapDirection.Both
End With

Dim parx As New Paragraph(figx)
Dim flowDoc As New FlowDocument(parx)

Remarks

XAML Attribute Usage

<object HorizontalOffset="double"/>
- or -
<object HorizontalOffset="qualifiedDouble"/>

XAML Values

double Double

String representation of a Double value equal to or greater than 0.0 but smaller than PositiveInfinity. An unqualified value is measured in device independent pixels. Strings need not explicitly include decimal points.

qualifiedDouble A double value as described above, (excepting Auto) followed by one of the following unit specifiers: px, in, cm, pt.

px (default) is device-independent units (1/96th inch per unit)

in is inches; 1in==96px

cm is centimeters; 1cm==(96/2.54) px

pt is points; 1pt==(96/72) px

Dependency Property Information

Item	Value
Identifier field	HorizontalOffsetProperty
Metadata properties set to `true`	AffectsParentMeasure

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via