Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
792 lines (667 sloc) 47.5 KB
<Type Name="Figure" FullName="System.Windows.Documents.Figure">
<TypeSignature Language="C#" Value="public class Figure : System.Windows.Documents.AnchoredBlock" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Figure extends System.Windows.Documents.AnchoredBlock" />
<TypeSignature Language="DocId" Value="T:System.Windows.Documents.Figure" />
<TypeSignature Language="VB.NET" Value="Public Class Figure&#xA;Inherits AnchoredBlock" />
<TypeSignature Language="C++ CLI" Value="public ref class Figure : System::Windows::Documents::AnchoredBlock" />
<TypeSignature Language="F#" Value="type Figure = class&#xA; inherit AnchoredBlock" />
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Documents.AnchoredBlock</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>An inline-level flow content element used to host a figure. A *figure* is a portion of flow content with placement properties that can be customized independently from the primary content flow within a <see cref="T:System.Windows.Documents.FlowDocument" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Windows.Documents.Figure> enforces a strong content model for child content. See [TextElement Content Model Overview](~/docs/framework/wpf/advanced/textelement-content-model-overview.md) for more information about the <xref:System.Windows.Documents.Figure> content model.
<xref:System.Windows.Documents.Figure> or <xref:System.Windows.Documents.Floater> elements are often used to highlight or accentuate portions of content, to host supporting images or other content within the main content flow, or to inject loosely related content such as advertisements.
<xref:System.Windows.Documents.Figure> and <xref:System.Windows.Documents.Floater> differ in several ways and are used for different scenarios.
**Figure:**
- Can be positioned: You can set its horizontal and vertical anchors to dock it relative to the page, content, column or paragraph. You can also use its <xref:System.Windows.Documents.Figure.HorizontalOffset%2A> and <xref:System.Windows.Documents.Figure.VerticalOffset%2A> properties to specify arbitrary offsets.
- Is sizable to more than one column: You can set <xref:System.Windows.Documents.Figure> height and width to multiples of page, content or column height or width. Note that in the case of page and content, multiples greater than 1 are not allowed. For example, you can set the width of a <xref:System.Windows.Documents.Figure> to be "0.5 page" or "0.25 content" or "2 Column". You can also set height and width to absolute pixel values.
- Does not paginate: If the content inside a <xref:System.Windows.Documents.Figure> does not fit inside the <xref:System.Windows.Documents.Figure>, it will render whatever content does fit and the remaining content is lost
**Floater:**
- Cannot be positioned and will render wherever space can be made available for it. You cannot set the offset or anchor a <xref:System.Windows.Documents.Floater>.
- Cannot be sized to more than one column: By default, <xref:System.Windows.Documents.Floater> sizes at one column. It has a <xref:System.Windows.Documents.Floater.Width%2A> property that can be set to an absolute pixel value, but if this value is greater than one column width it is ignored and the floater is sized at one column. You can size it to less than one column by setting the correct pixel width, but sizing is not column-relative, so "0.5Column" is not a valid expression for <xref:System.Windows.Documents.Floater> width. <xref:System.Windows.Documents.Floater> has no height property and it's height cannot be set, it's height depends on the content
- <xref:System.Windows.Documents.Floater> paginates: If its content at its specified width extends to more than 1 column height, floater breaks and paginates to the next column, the next page, etc.
<xref:System.Windows.Documents.Figure> is a good place to put standalone content where you want to control the size and positioning, and are confident that the content will fit in the specified size. <xref:System.Windows.Documents.Floater> is a good place to put more free-flowing content that flows similar to the main page content, but is separated from it.
## Examples
The following example defines a <xref:System.Windows.Documents.FlowDocument> that contains both <xref:System.Windows.Documents.Floater> and <xref:System.Windows.Documents.Figure> elements.
[!code-xaml[FloaterFigureSnippets#_FloaterFigureXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_floaterfigurexaml)]
The following figure shows how this example renders.
![Screenshot: Floaters and Figures in a FlowDocument](~/add/media/floaterfigure.png "Screenshot: Floaters and Figures in a FlowDocument")
]]></format>
</remarks>
<altmember cref="T:System.Windows.Documents.FlowDocument" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Documents.Figure" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Figure ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Documents.Figure.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Figure();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new, empty instance of the <see cref="T:System.Windows.Documents.Figure" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Figure (System.Windows.Documents.Block childBlock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Windows.Documents.Block childBlock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Documents.Figure.#ctor(System.Windows.Documents.Block)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (childBlock As Block)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Figure(System::Windows::Documents::Block ^ childBlock);" />
<MemberSignature Language="F#" Value="new System.Windows.Documents.Figure : System.Windows.Documents.Block -&gt; System.Windows.Documents.Figure" Usage="new System.Windows.Documents.Figure childBlock" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="childBlock" Type="System.Windows.Documents.Block" />
</Parameters>
<Docs>
<param name="childBlock">A <see cref="T:System.Windows.Documents.Block" /> object specifying the initial contents of the new <see cref="T:System.Windows.Documents.Figure" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Documents.Figure" /> class, taking a specified <see cref="T:System.Windows.Documents.Block" /> object as the initial contents of the new <see cref="T:System.Windows.Documents.Figure" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates the use of this constructor.
[!code-csharp[FloaterFigureSnippets#_FigureConst1](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureconst1)]
[!code-vb[FloaterFigureSnippets#_FigureConst1](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureconst1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Figure (System.Windows.Documents.Block childBlock, System.Windows.Documents.TextPointer insertionPosition);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Windows.Documents.Block childBlock, class System.Windows.Documents.TextPointer insertionPosition) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Documents.Figure.#ctor(System.Windows.Documents.Block,System.Windows.Documents.TextPointer)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (childBlock As Block, insertionPosition As TextPointer)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Figure(System::Windows::Documents::Block ^ childBlock, System::Windows::Documents::TextPointer ^ insertionPosition);" />
<MemberSignature Language="F#" Value="new System.Windows.Documents.Figure : System.Windows.Documents.Block * System.Windows.Documents.TextPointer -&gt; System.Windows.Documents.Figure" Usage="new System.Windows.Documents.Figure (childBlock, insertionPosition)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="childBlock" Type="System.Windows.Documents.Block" />
<Parameter Name="insertionPosition" Type="System.Windows.Documents.TextPointer" />
</Parameters>
<Docs>
<param name="childBlock">A <see cref="T:System.Windows.Documents.Block" /> object specifying the initial contents of the new <see cref="T:System.Windows.Documents.Figure" />. This parameter may be <see langword="null" />, in which case no <see cref="T:System.Windows.Documents.Block" /> is inserted.</param>
<param name="insertionPosition">A <see cref="T:System.Windows.Documents.TextPointer" /> specifying an insertion position at which to insert the <see cref="T:System.Windows.Documents.Figure" /> element after it is created, or <see langword="null" /> for no automatic insertion.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Documents.Figure" /> class, taking a specified <see cref="T:System.Windows.Documents.Block" /> object as the initial contents of the new <see cref="T:System.Windows.Documents.Figure" />, and a <see cref="T:System.Windows.Documents.TextPointer" /> specifying an insertion position for the new <see cref="T:System.Windows.Documents.Figure" /> element.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates the use of this constructor.
[!code-csharp[FloaterFigureSnippets#_FigureConst2](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureconst2)]
[!code-vb[FloaterFigureSnippets#_FigureConst2](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureconst2)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CanDelayPlacement">
<MemberSignature Language="C#" Value="public bool CanDelayPlacement { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanDelayPlacement" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.CanDelayPlacement" />
<MemberSignature Language="VB.NET" Value="Public Property CanDelayPlacement As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool CanDelayPlacement { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.CanDelayPlacement : bool with get, set" Usage="System.Windows.Documents.Figure.CanDelayPlacement" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether this figure can delay its placement in the flow of content.</summary>
<value>
<see langword="true" /> if this figure can delay placement; otherwise, <see langword="false" />. The default value is <see langword="true" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_CanDelayPlacement"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.CanDelayPlacementProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CanDelayPlacementProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty CanDelayPlacementProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty CanDelayPlacementProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.CanDelayPlacementProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly CanDelayPlacementProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ CanDelayPlacementProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable CanDelayPlacementProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.CanDelayPlacementProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.CanDelayPlacement" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public System.Windows.FigureLength Height { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.FigureLength Height" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.Height" />
<MemberSignature Language="VB.NET" Value="Public Property Height As FigureLength" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::FigureLength Height { System::Windows::FigureLength get(); void set(System::Windows::FigureLength value); };" />
<MemberSignature Language="F#" Value="member this.Height : System.Windows.FigureLength with get, set" Usage="System.Windows.Documents.Figure.Height" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.FigureLength</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the height of a <see cref="T:System.Windows.Documents.Figure" /> element.</summary>
<value>A <see cref="T:System.Windows.FigureLength" /> structure specifying the height characteristics for the <see cref="T:System.Windows.Documents.Figure" />.
The default value is <see cref="T:System.Windows.FigureLength" />.<see cref="P:System.Windows.FigureLength.Value" /> = **1.0** and <see cref="T:System.Windows.FigureLength" />.<see cref="P:System.Windows.FigureLength.FigureUnitType" /> = <see cref="F:System.Windows.FigureUnitType.Auto" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_Height"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.HeightProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.Height%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.Height%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HeightProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty HeightProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty HeightProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.HeightProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly HeightProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ HeightProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable HeightProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.HeightProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.Height" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HorizontalAnchor">
<MemberSignature Language="C#" Value="public System.Windows.FigureHorizontalAnchor HorizontalAnchor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.FigureHorizontalAnchor HorizontalAnchor" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.HorizontalAnchor" />
<MemberSignature Language="VB.NET" Value="Public Property HorizontalAnchor As FigureHorizontalAnchor" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::FigureHorizontalAnchor HorizontalAnchor { System::Windows::FigureHorizontalAnchor get(); void set(System::Windows::FigureHorizontalAnchor value); };" />
<MemberSignature Language="F#" Value="member this.HorizontalAnchor : System.Windows.FigureHorizontalAnchor with get, set" Usage="System.Windows.Documents.Figure.HorizontalAnchor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.FigureHorizontalAnchor</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the position that content is anchored to in the horizontal direction.</summary>
<value>A member of the <see cref="T:System.Windows.FigureHorizontalAnchor" /> enumeration specifying a horizontal anchor location for the <see cref="T:System.Windows.Documents.Figure" />.
The default value is <see cref="F:System.Windows.FigureHorizontalAnchor.ColumnRight" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_HorizontalAnchor"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.HorizontalAnchorProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.HorizontalAnchor%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.HorizontalAnchor%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HorizontalAnchorProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty HorizontalAnchorProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty HorizontalAnchorProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.HorizontalAnchorProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly HorizontalAnchorProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ HorizontalAnchorProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable HorizontalAnchorProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.HorizontalAnchorProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.HorizontalAnchor" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HorizontalOffset">
<MemberSignature Language="C#" Value="public double HorizontalOffset { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 HorizontalOffset" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.HorizontalOffset" />
<MemberSignature Language="VB.NET" Value="Public Property HorizontalOffset As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double HorizontalOffset { double get(); void set(double value); };" />
<MemberSignature Language="F#" Value="member this.HorizontalOffset : double with get, set" Usage="System.Windows.Documents.Figure.HorizontalOffset" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the distance that a <see cref="T:System.Windows.Documents.Figure" /> is offset from its baseline in the horizontal direction.</summary>
<value>The distance that a <see cref="T:System.Windows.Documents.Figure" /> is offset from its baseline in the horizontal direction, in device independent pixels.
The default value is **0.0**.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="xamlAttributeUsage_HorizontalOffset"></a>
## XAML Attribute Usage
```
<object HorizontalOffset="double"/>
- or -
<object HorizontalOffset="qualifiedDouble"/>
```
<a name="xamlValues_HorizontalOffset"></a>
## XAML Values
*double*
<xref:System.Double>
String representation of a <xref:System.Double> value equal to or greater than **0.0** but smaller than <xref:System.Double.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 [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)]
`in` is inches; 1in==96px
`cm` is centimeters; 1cm==(96/2.54) px
`pt` is points; 1pt==(96/72) px
<a name="dependencyPropertyInfo_HorizontalOffset"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.HorizontalOffsetProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.HorizontalOffset%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.HorizontalOffset%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HorizontalOffsetProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty HorizontalOffsetProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty HorizontalOffsetProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.HorizontalOffsetProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly HorizontalOffsetProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ HorizontalOffsetProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable HorizontalOffsetProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.HorizontalOffsetProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.HorizontalOffset" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="VerticalAnchor">
<MemberSignature Language="C#" Value="public System.Windows.FigureVerticalAnchor VerticalAnchor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.FigureVerticalAnchor VerticalAnchor" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.VerticalAnchor" />
<MemberSignature Language="VB.NET" Value="Public Property VerticalAnchor As FigureVerticalAnchor" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::FigureVerticalAnchor VerticalAnchor { System::Windows::FigureVerticalAnchor get(); void set(System::Windows::FigureVerticalAnchor value); };" />
<MemberSignature Language="F#" Value="member this.VerticalAnchor : System.Windows.FigureVerticalAnchor with get, set" Usage="System.Windows.Documents.Figure.VerticalAnchor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.FigureVerticalAnchor</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the position that content is anchored to in the vertical direction.</summary>
<value>A member of the <see cref="T:System.Windows.FigureVerticalAnchor" /> enumeration specifying a vertical anchor location for the <see cref="T:System.Windows.Documents.Figure" />.
The default value is <see cref="F:System.Windows.FigureVerticalAnchor.ParagraphTop" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_VerticalAnchor"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.VerticalAnchorProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.VerticalAnchor%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.VerticalAnchor%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="VerticalAnchorProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty VerticalAnchorProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty VerticalAnchorProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.VerticalAnchorProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly VerticalAnchorProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ VerticalAnchorProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable VerticalAnchorProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.VerticalAnchorProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.VerticalAnchor" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="VerticalOffset">
<MemberSignature Language="C#" Value="public double VerticalOffset { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 VerticalOffset" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.VerticalOffset" />
<MemberSignature Language="VB.NET" Value="Public Property VerticalOffset As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double VerticalOffset { double get(); void set(double value); };" />
<MemberSignature Language="F#" Value="member this.VerticalOffset : double with get, set" Usage="System.Windows.Documents.Figure.VerticalOffset" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Windows.LengthConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the distance that a <see cref="T:System.Windows.Documents.Figure" /> is offset from its baseline in the vertical direction.</summary>
<value>The distance that a <see cref="T:System.Windows.Documents.Figure" /> is offset from its baseline in the vertical direction, in device independent pixels.
The default value is **0.0**.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="xamlAttributeUsage_VerticalOffset"></a>
## XAML Attribute Usage
```
<object VerticalOffset="double"/>
- or -
<object VerticalOffset="qualifiedDouble"/>
```
<a name="xamlValues_VerticalOffset"></a>
## XAML Values
*double*
<xref:System.Double>
String representation of a <xref:System.Double> value equal to or greater than **0.0** but smaller than <xref:System.Double.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 [!INCLUDE[TLA#tla_dipixel#plural](~/includes/tlasharptla-dipixelsharpplural-md.md)]
`in` is inches; 1in==96px
`cm` is centimeters; 1cm==(96/2.54) px
`pt` is points; 1pt==(96/72) px
<a name="dependencyPropertyInfo_VerticalOffset"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.VerticalOffsetProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.VerticalOffset%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.VerticalOffset%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="VerticalOffsetProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty VerticalOffsetProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty VerticalOffsetProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.VerticalOffsetProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly VerticalOffsetProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ VerticalOffsetProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable VerticalOffsetProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.VerticalOffsetProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.VerticalOffset" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public System.Windows.FigureLength Width { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.FigureLength Width" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.Width" />
<MemberSignature Language="VB.NET" Value="Public Property Width As FigureLength" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::FigureLength Width { System::Windows::FigureLength get(); void set(System::Windows::FigureLength value); };" />
<MemberSignature Language="F#" Value="member this.Width : System.Windows.FigureLength with get, set" Usage="System.Windows.Documents.Figure.Width" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.FigureLength</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the width of a <see cref="T:System.Windows.Documents.Figure" /> element.</summary>
<value>A <see cref="T:System.Windows.FigureLength" /> structure specifying the width characteristics for the <see cref="T:System.Windows.Documents.Figure" />.
The default value is <see cref="T:System.Windows.FigureLength" />.<see cref="P:System.Windows.FigureLength.Value" /> = **1.0** and <see cref="T:System.Windows.FigureLength" />.<see cref="P:System.Windows.FigureLength.FigureUnitType" /> = <see cref="F:System.Windows.FigureUnitType.Auto" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_Width"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.WidthProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.Width%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.Width%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WidthProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty WidthProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty WidthProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.WidthProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly WidthProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ WidthProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable WidthProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.WidthProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.Width" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WrapDirection">
<MemberSignature Language="C#" Value="public System.Windows.WrapDirection WrapDirection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.WrapDirection WrapDirection" />
<MemberSignature Language="DocId" Value="P:System.Windows.Documents.Figure.WrapDirection" />
<MemberSignature Language="VB.NET" Value="Public Property WrapDirection As WrapDirection" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::WrapDirection WrapDirection { System::Windows::WrapDirection get(); void set(System::Windows::WrapDirection value); };" />
<MemberSignature Language="F#" Value="member this.WrapDirection : System.Windows.WrapDirection with get, set" Usage="System.Windows.Documents.Figure.WrapDirection" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.WrapDirection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates the allowable ways in which content can flow around a <see cref="T:System.Windows.Documents.Figure" />.</summary>
<value>A member of the <see cref="T:System.Windows.WrapDirection" /> enumeration specifying the allowable ways in which content can flow around a <see cref="T:System.Windows.Documents.Figure" />.
The default value is <see cref="F:System.Windows.WrapDirection.Both" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<a name="dependencyPropertyInfo_WrapDirection"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Documents.Figure.WrapDirectionProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.AffectsParentMeasure%2A>|
## Examples
The following example shows how to set the <xref:System.Windows.Documents.Figure.WrapDirection%2A> attribute of a <xref:System.Windows.Documents.Figure> element.
[!code-xaml[FloaterFigureSnippets#_FigurePropsXAML](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml#_figurepropsxaml)]
The following example shows how to set the <xref:System.Windows.Documents.Figure.WrapDirection%2A> property programmatically.
[!code-csharp[FloaterFigureSnippets#_FigureProps](~/samples/snippets/csharp/VS_Snippets_Wpf/FloaterFigureSnippets/CSharp/Window1.xaml.cs#_figureprops)]
[!code-vb[FloaterFigureSnippets#_FigureProps](~/samples/snippets/visualbasic/VS_Snippets_Wpf/FloaterFigureSnippets/visualbasic/window1.xaml.vb#_figureprops)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WrapDirectionProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty WrapDirectionProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty WrapDirectionProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Documents.Figure.WrapDirectionProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly WrapDirectionProperty As DependencyProperty " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ WrapDirectionProperty;" />
<MemberSignature Language="F#" Value=" staticval mutable WrapDirectionProperty : System.Windows.DependencyProperty" Usage="System.Windows.Documents.Figure.WrapDirectionProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Documents.Figure.WrapDirection" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.