TextFormattingRunProperties Class

 

Holds text formatting property information. This class derives from the abstract TextRunProperties class.

Namespace:   Microsoft.VisualStudio.Text.Formatting
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

System.Object
  System.Windows.Media.TextFormatting.TextRunProperties
    Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties

[SerializableAttribute]
public sealed class TextFormattingRunProperties : TextRunProperties, 
	ISerializable, IObjectReference

NameDescription
System_CAPS_pubpropertyBackgroundBrush

Gets the background brush.(Overrides TextRunProperties.BackgroundBrush.)

System_CAPS_pubpropertyBackgroundBrushEmpty

Determines whether the background brush is empty.

System_CAPS_pubpropertyBackgroundOpacity

Returns the opacity of the background.

System_CAPS_pubpropertyBackgroundOpacityEmpty

Determines whether any custom opacity is explicitly set for the background.

System_CAPS_pubpropertyBaselineAlignment

(Inherited from TextRunProperties.)

System_CAPS_pubpropertyBold

Determines whether the formatting is made explicitly bold.

System_CAPS_pubpropertyBoldEmpty

Determines whether the bold property is set.

System_CAPS_pubpropertyCultureInfo

Gets the culture information.(Overrides TextRunProperties.CultureInfo.)

System_CAPS_pubpropertyCultureInfoEmpty

Determines whether the culture info is empty.

System_CAPS_pubpropertyFontHintingEmSize

Gets the font hinting size.(Overrides TextRunProperties.FontHintingEmSize.)

System_CAPS_pubpropertyFontHintingEmSizeEmpty

Determines whether the font hinting size is empty.

System_CAPS_pubpropertyFontRenderingEmSize

Gets the font rendering size.(Overrides TextRunProperties.FontRenderingEmSize.)

System_CAPS_pubpropertyFontRenderingEmSizeEmpty

Determines whether the size is empty.

System_CAPS_pubpropertyForegroundBrush

Gets the foreground brush.(Overrides TextRunProperties.ForegroundBrush.)

System_CAPS_pubpropertyForegroundBrushEmpty

Determines whether the foreground brush is empty.

System_CAPS_pubpropertyForegroundOpacity

Gets the opacity of the foreground.

System_CAPS_pubpropertyForegroundOpacityEmpty

Determines whether any custom opacity is explicitly set for the foreground.

System_CAPS_pubpropertyItalic

Determines whether the formatting is made explicitly italic.

System_CAPS_pubpropertyItalicEmpty

Determines whether the italic property is set.

System_CAPS_pubpropertyNumberSubstitution

(Inherited from TextRunProperties.)

System_CAPS_pubpropertyTextDecorations

Gets the decorations for the text.(Overrides TextRunProperties.TextDecorations.)

System_CAPS_pubpropertyTextDecorationsEmpty

Determines whether the text decorations collection is empty.

System_CAPS_pubpropertyTextEffects

Gets the text effects for the text.(Overrides TextRunProperties.TextEffects.)

System_CAPS_pubpropertyTextEffectsEmpty

Determines whether the text effects collection is empty.

System_CAPS_pubpropertyTypeface

Gets the typeface for the text.(Overrides TextRunProperties.Typeface.)

System_CAPS_pubpropertyTypefaceEmpty

Determines whether the typeface is empty.

System_CAPS_pubpropertyTypographyProperties

(Inherited from TextRunProperties.)

NameDescription
System_CAPS_pubmethodBackgroundBrushSame(Brush)

Determines whether the background brush for this TextFormattingRunProperties is the same as the specified brush.

System_CAPS_pubmethodClearBackgroundBrush()

Gets a new TextFormattingRunProperties with all properties the same except for the background brush.

System_CAPS_pubmethodClearBackgroundOpacity()

Gets a new TextFormattingRunProperties with the BackgroundOpacity property cleared.

System_CAPS_pubmethodClearBold()

Gets a new TextFormattingRunProperties with the Bold property cleared.

System_CAPS_pubmethodClearCultureInfo()

Gets a new TextFormattingRunProperties with all properties the same except for the culture info.

System_CAPS_pubmethodClearFontHintingEmSize()

Gets a new TextFormattingRunProperties with all properties the same except for the font hinting size.

System_CAPS_pubmethodClearFontRenderingEmSize()

Gets a new TextFormattingRunProperties with all properties the same except for the rendering size.

System_CAPS_pubmethodClearForegroundBrush()

Gets a new TextFormattingRunProperties with all properties the same except for the foreground brush.

System_CAPS_pubmethodClearForegroundOpacity()

Gets a new TextFormattingRunProperties with the ForegroundOpacity property cleared.

System_CAPS_pubmethodClearItalic()

Gets a new TextFormattingRunProperties with all properties the same, but clears the Italic property.

System_CAPS_pubmethodClearTextDecorations()

Gets a new TextFormattingRunProperties with all properties the same except for the text decorations.

System_CAPS_pubmethodClearTextEffects()

Gets a new TextFormattingRunProperties with all properties the same except for the text effects.

System_CAPS_pubmethodClearTypeface()

Gets a new TextFormattingRunProperties with all properties the same except for the typeface.

System_CAPS_pubmethodSystem_CAPS_staticCreateTextFormattingRunProperties()

Initializes a new instance of TextFormattingRunProperties.

System_CAPS_pubmethodSystem_CAPS_staticCreateTextFormattingRunProperties(Brush, Brush, Typeface, Nullable<Double>, Nullable<Double>, TextDecorationCollection, TextEffectCollection, CultureInfo)

Initializes a new instance of TextFormattingRunProperties with the specified options.

System_CAPS_pubmethodSystem_CAPS_staticCreateTextFormattingRunProperties(Typeface, Double, Color)

Initializes a new instance of TextFormattingRunProperties with the specified options.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodForegroundBrushSame(Brush)

Determines whether the foreground brush for this TextFormattingRunProperties is the same as the specified.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Serializes the TextFormattingRunProperties object using a XamlWriter.

System_CAPS_pubmethodGetRealObject(StreamingContext)

Gets the cached TextFormattingRunProperties object, or creates one if none exists.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSameSize(TextFormattingRunProperties)

Determines whether font sizes for two TextFormattingRunProperties objects are the same.

System_CAPS_pubmethodSetBackground(Color)

Gets a new TextFormattingRunProperties with the properties of this one but with the background set to the specified color.

System_CAPS_pubmethodSetBackgroundBrush(Brush)

Gets a new TextFormattingRunProperties with the properties of this one but with the background brush set to the specified brush.

System_CAPS_pubmethodSetBackgroundOpacity(Double)

Gets a new TextFormattingRunProperties with the BackgroundOpacity property set to the specified opacity.

System_CAPS_pubmethodSetBold(Boolean)

Returns a new TextFormattingRunProperties with the properties of this one but with the Bold property set the specified bold value.

System_CAPS_pubmethodSetCultureInfo(CultureInfo)

Gets a new TextFormattingRunProperties with the properties of this one but with the culture set to the specified culture information.

System_CAPS_pubmethodSetFontHintingEmSize(Double)

Gets a new TextFormattingRunProperties with the properties of this one but with the font hinting size set to the specified size.

System_CAPS_pubmethodSetFontRenderingEmSize(Double)

Gets a new TextFormattingRunProperties with the properties of this one but with the font rendering size set to the specified size.

System_CAPS_pubmethodSetForeground(Color)

Gets a new TextFormattingRunProperties with the properties of this one but with the foreground set to the specified color

System_CAPS_pubmethodSetForegroundBrush(Brush)

Gets a new TextFormattingRunProperties with the properties of this one but with the new foreground Brush set to the specified brush.

System_CAPS_pubmethodSetForegroundOpacity(Double)

Gets a new TextFormattingRunProperties with the properties of this one but with the ForegroundOpacity property set to the specified opacity.

System_CAPS_pubmethodSetItalic(Boolean)

Gets a new TextFormattingRunProperties with the properties of this one but with the Italic property set to the italic value.

System_CAPS_pubmethodSetTextDecorations(TextDecorationCollection)

Gets a new TextFormattingRunProperties with the properties of this one but with the text decorations set to the specified text decorations.

System_CAPS_pubmethodSetTextEffects(TextEffectCollection)

Gets a new TextFormattingRunProperties with the properties of this one but with the text effects set to the specified text effects.

System_CAPS_pubmethodSetTypeface(Typeface)

Gets a new TextFormattingRunProperties with the properties of this one but with the typeface set to the specified typeface.

System_CAPS_pubmethodToString()

(Inherited from Object.)

This class is used to hold all information about the text formatting properties. Once created, it is immutable, and all modifications of the object return different objects. For each unique set of TextFormattingRunProperties there exists exactly one object. If a TextFormattingRunProperties has reference equality to another, their properties are identical. Conversely, if a TextFormattingRunProperties object has reference inequality, their properties are different.

Checking reference equality is the only way to determine whether two TextFormattingRunProperties are different. Checking the equality of each property of the object may indicate the two are identical, but that may or may not be the case.

A TextFormattingRunProperties instance may have empty properties. An empty property inherits the empty properties from some additional text. TextFormattingRunProperties has methods that determine whether a property is empty or not (PropertyNameEmpty) and that empty a property (PropertyNameClear).

All freezable fields of the TextFormattingRunProperties object are frozen on creation.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: