Class TextVisual3D

Namespace

HelixToolkit.Wpf

Assembly

HelixToolkit.Wpf.dll

A visual element that shows text.

public class TextVisual3D : ModelVisual3D, IAnimatable, IAddChild

Inheritance

object

DispatcherObject

DependencyObject

Visual3D

ModelVisual3D

TextVisual3D

Implements

IAnimatable

IAddChild

Inherited Members

ModelVisual3D.ContentProperty

ModelVisual3D.TransformProperty

ModelVisual3D.GetVisual3DChild(int)

ModelVisual3D.Children

ModelVisual3D.Content

ModelVisual3D.Transform

ModelVisual3D.Visual3DChildrenCount

Visual3D.AddVisual3DChild(Visual3D)

Visual3D.ApplyAnimationClock(DependencyProperty, AnimationClock)

Visual3D.ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Visual3D.BeginAnimation(DependencyProperty, AnimationTimeline)

Visual3D.BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Visual3D.FindCommonVisualAncestor(DependencyObject)

Visual3D.GetAnimationBaseValue(DependencyProperty)

Visual3D.IsAncestorOf(DependencyObject)

Visual3D.IsDescendantOf(DependencyObject)

Visual3D.OnVisualChildrenChanged(DependencyObject, DependencyObject)

Visual3D.OnVisualParentChanged(DependencyObject)

Visual3D.RemoveVisual3DChild(Visual3D)

Visual3D.TransformToAncestor(Visual3D)

Visual3D.TransformToAncestor(Visual)

Visual3D.TransformToDescendant(Visual3D)

Visual3D.HasAnimatedProperties

Visual3D.Visual3DModel

DependencyObject.ClearValue(DependencyProperty)

DependencyObject.ClearValue(DependencyPropertyKey)

DependencyObject.CoerceValue(DependencyProperty)

DependencyObject.Equals(object)

DependencyObject.GetHashCode()

DependencyObject.GetLocalValueEnumerator()

DependencyObject.GetValue(DependencyProperty)

DependencyObject.InvalidateProperty(DependencyProperty)

DependencyObject.OnPropertyChanged(DependencyPropertyChangedEventArgs)

DependencyObject.ReadLocalValue(DependencyProperty)

DependencyObject.SetCurrentValue(DependencyProperty, object)

DependencyObject.SetValue(DependencyProperty, object)

DependencyObject.SetValue(DependencyPropertyKey, object)

DependencyObject.ShouldSerializeProperty(DependencyProperty)

DependencyObject.DependencyObjectType

DependencyObject.IsSealed

DispatcherObject.Dispatcher

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

AttachedProperties.GetName(DependencyObject)

AttachedProperties.SetName(DependencyObject, string)

AnimationExtensions.AnimateOpacity(IAnimatable, double, double)

Visual3DHelper.FindBounds(Visual3D, Transform3D)

Visual3DHelper.GetTransform(Visual3D)

Visual3DHelper.GetTransformTo(Visual3D, Model3D)

Visual3DHelper.GetViewport(Visual3D)

Visual3DHelper.GetViewport3D(Visual3D)

Visual3DHelper.GetViewportTransform(Visual3D)

Visual3DHelper.IsAttachedToViewport3D(Visual3D)

Visual3DHelper.Traverse<T>(Visual3D, Action<T, Transform3D>)

Visual3DHelper.Traverse<T>(Visual3D, Action<T, Visual3D, Transform3D>)

Remarks

Set the Text property last to avoid multiple updates.

Fields

AngleProperty

Identifies the Angle dependency property.

public static readonly DependencyProperty AngleProperty

Field Value

DependencyProperty

BackgroundProperty

Identifies the Background dependency property.

public static readonly DependencyProperty BackgroundProperty

Field Value

DependencyProperty

BorderBrushProperty

Identifies the BorderBrush dependency property.

public static readonly DependencyProperty BorderBrushProperty

Field Value

DependencyProperty

BorderThicknessProperty

Identifies the BorderThickness dependency property.

public static readonly DependencyProperty BorderThicknessProperty

Field Value

DependencyProperty

FontFamilyProperty

Identifies the FontFamily dependency property.

public static readonly DependencyProperty FontFamilyProperty

Field Value

DependencyProperty

FontSizeProperty

Identifies the FontSize dependency property.

public static readonly DependencyProperty FontSizeProperty

Field Value

DependencyProperty

FontWeightProperty

Identifies the FontWeight dependency property.

public static readonly DependencyProperty FontWeightProperty

Field Value

DependencyProperty

ForegroundProperty

Identifies the Foreground dependency property.

public static readonly DependencyProperty ForegroundProperty

Field Value

DependencyProperty

HeightProperty

Identifies the Height dependency property.

public static readonly DependencyProperty HeightProperty

Field Value

DependencyProperty

HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

public static readonly DependencyProperty HorizontalAlignmentProperty

Field Value

DependencyProperty

IsDoubleSidedProperty

Identifies the IsDoubleSided dependency property.

public static readonly DependencyProperty IsDoubleSidedProperty

Field Value

DependencyProperty

IsFlippedProperty

Identifies the IsFlipped dependency property.

public static readonly DependencyProperty IsFlippedProperty

Field Value

DependencyProperty

PaddingProperty

Identifies the Padding dependency property.

public static readonly DependencyProperty PaddingProperty

Field Value

DependencyProperty

PositionProperty

Identifies the Position dependency property.

public static readonly DependencyProperty PositionProperty

Field Value

DependencyProperty

TextDirectionProperty

Identifies the TextDirection dependency property.

public static readonly DependencyProperty TextDirectionProperty

Field Value

DependencyProperty

TextProperty

Identifies the Text dependency property.

public static readonly DependencyProperty TextProperty

Field Value

DependencyProperty

UpDirectionProperty

Identifies the UpDirection dependency property.

public static readonly DependencyProperty UpDirectionProperty

Field Value

DependencyProperty

VerticalAlignmentProperty

Identifies the VerticalAlignment dependency property.

public static readonly DependencyProperty VerticalAlignmentProperty

Field Value

DependencyProperty

Properties

Angle

The rotation angle of the text in counter-clockwise, in degrees.

public double Angle { get; set; }

Property Value

double

Background

Gets or sets the background brush.

public Brush Background { get; set; }

Property Value

Brush

The background.

BorderBrush

Gets or sets the border brush.

public Brush BorderBrush { get; set; }

Property Value

Brush

The border brush.

BorderThickness

Gets or sets the border thickness.

public Thickness BorderThickness { get; set; }

Property Value

Thickness

The border thickness.

FontFamily

Gets or sets the font family.

public FontFamily FontFamily { get; set; }

Property Value

FontFamily

The font family.

FontSize

Gets or sets the size of the font (if not set, the Height property is used.

public double FontSize { get; set; }

Property Value

double

The size of the font.

FontWeight

Gets or sets the font weight.

public FontWeight FontWeight { get; set; }

Property Value

FontWeight

The font weight.

Foreground

Gets or sets the foreground (text) brush.

public Brush Foreground { get; set; }

Property Value

Brush

The foreground brush.

Height

Gets or sets the height of the text.

public double Height { get; set; }

Property Value

double

The text height.

HorizontalAlignment

Gets or sets the horizontal alignment.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

The horizontal alignment.

IsDoubleSided

Gets or sets a value indicating whether this text visual is double sided.

public bool IsDoubleSided { get; set; }

Property Value

bool

true if this instance is double sided; otherwise, false.

IsFlipped

Gets or sets a value indicating whether the text should be flipped (mirrored horizontally).

public bool IsFlipped { get; set; }

Property Value

bool

true if text is flipped; otherwise, false.

Remarks

This may be useful when using a mirror transform on the text visual.

Padding

Gets or sets the padding.

public Thickness Padding { get; set; }

Property Value

Thickness

The padding.

Position

Gets or sets the position of the text.

public Point3D Position { get; set; }

Property Value

Point3D

The position.

Text

Gets or sets the text.

public string Text { get; set; }

Property Value

string

The text.

TextDirection

Gets or sets the text direction.

public Vector3D TextDirection { get; set; }

Property Value

Vector3D

The direction.

UpDirection

Gets or sets the up direction of the text.

public Vector3D UpDirection { get; set; }

Property Value

Vector3D

The up direction.

VerticalAlignment

Gets or sets the vertical alignment.

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

The vertical alignment.