FigureLength FigureLength FigureLength FigureLength Struct

Definition

Describes the height or width of a Figure.

public value class FigureLength : IEquatable<System::Windows::FigureLength>
[System.ComponentModel.TypeConverter(typeof(System.Windows.FigureLengthConverter))]
public struct FigureLength : IEquatable<System.Windows.FigureLength>
type FigureLength = struct
Public Structure FigureLength
Implements IEquatable(Of FigureLength)
Inheritance
FigureLengthFigureLengthFigureLengthFigureLength
Attributes
Implements

Examples

In the following example, when the user clicks on the Figure, the Width of the Figure decreases. Below is the XAML for the sample.

<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  x:Class="SDKSample.FigureLengthExample" >

  <FlowDocumentReader>
    <FlowDocument >
      <Paragraph>
        Raw text inside the paragraph
        <Figure Name="myFigure" Width="300">
          <Paragraph FontStyle="Italic" MouseDown="OnMouseDownDecreaseWidth" >
            Text inside of paragraph that is inside Figure...
          </Paragraph>
        </Figure>
      </Paragraph>
    </FlowDocument>
  </FlowDocumentReader>



</Page>

Below is the code used to decrease the Width of the Figure.

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Input;

namespace SDKSample
{
    public partial class FigureLengthExample : Page
	{

        void OnMouseDownDecreaseWidth(object sender, MouseButtonEventArgs args)
        {
            FigureLength myFigureLength = myFigure.Width;
            double widthValue = myFigureLength.Value;
            if (widthValue > 0)
            {
                myFigure.Width = new FigureLength((widthValue - 10), FigureUnitType.Pixel);
            }
        }
    }
}

Remarks

XAML Attribute Usage

<object property="length"/>  
- or -  
<object property="qualifiedDouble"/>  

XAML Values

length
The width or height of the Figure in pixels, described as a Double value. Alternatively, this value can be qualified with a unit declaration string (px, in, cm, pt) see qualifiedDouble below.

qualifiedDouble
A double value as described above followed by one of the following unit declaration strings: 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

Constructors

FigureLength(Double) FigureLength(Double) FigureLength(Double) FigureLength(Double)

Initializes a new instance of the FigureLength class with the specified number of pixels in length.

FigureLength(Double, FigureUnitType) FigureLength(Double, FigureUnitType) FigureLength(Double, FigureUnitType) FigureLength(Double, FigureUnitType)

Initializes a new instance of the FigureLength class with the specified Value and FigureUnitType.

Properties

FigureUnitType FigureUnitType FigureUnitType FigureUnitType

Gets the unit type of the Value.

IsAbsolute IsAbsolute IsAbsolute IsAbsolute

Gets a value that determines whether this FigureLength holds an absolute value (in pixels).

IsAuto IsAuto IsAuto IsAuto

Gets a value that determines whether this FigureLength is automatic (not specified).

IsColumn IsColumn IsColumn IsColumn

Gets a value that determines whether this FigureLength has a FigureUnitType property value of Column.

IsContent IsContent IsContent IsContent

Gets a value that determines whether this FigureLength has a FigureUnitType property value of Content.

IsPage IsPage IsPage IsPage

Gets a value that determines whether this FigureLength has a FigureUnitType property value of Page.

Value Value Value Value

Gets the value of this FigureLength.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified Object is a FigureLength and whether it is identical to this FigureLength.

Equals(FigureLength) Equals(FigureLength) Equals(FigureLength) Equals(FigureLength)

Compares two FigureLength structures for equality.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this FigureLength.

ToString() ToString() ToString() ToString()

Creates a String representation of this FigureLength.

Operators

Equality(FigureLength, FigureLength) Equality(FigureLength, FigureLength) Equality(FigureLength, FigureLength) Equality(FigureLength, FigureLength)

Compares two FigureLength structures for equality.

Inequality(FigureLength, FigureLength) Inequality(FigureLength, FigureLength) Inequality(FigureLength, FigureLength) Inequality(FigureLength, FigureLength)

Compares two FigureLength structures for inequality.

Applies to