Skip to content

TextStudioAppearanceProperties

ClassTextStudioTextStudio
public static class TextStudioAppearanceProperties

Typed property metadata and validated reading, writing, and target resolution for exposed appearance parameters.

TryGet(TextStudioAppearanceProperty, out TextStudioAppearancePropertyDescriptor)

Section titled “TryGet(TextStudioAppearanceProperty, out TextStudioAppearancePropertyDescriptor)”
public static bool TryGet(TextStudioAppearanceProperty property, out TextStudioAppearancePropertyDescriptor descriptor)

Attempts to retrieve the descriptor for a supported appearance-property identifier.

Parameters

NameType
propertyTextStudio.TextStudioAppearanceProperty
descriptorTextStudio.TextStudioAppearancePropertyDescriptor

Returns

System.Boolean

IsSupported(in TextStudio2DLayer, TextStudioAppearanceProperty)

Section titled “IsSupported(in TextStudio2DLayer, TextStudioAppearanceProperty)”
public static bool IsSupported(in TextStudio2DLayer layer, TextStudioAppearanceProperty property)

Checks whether a layer supports exposing the specified property, including restrictions on referenced paints and preserved native fills.

Parameters

NameType
layerTextStudio.TextStudio2DLayer
propertyTextStudio.TextStudioAppearanceProperty

Returns

System.Boolean

TryRead(in TextStudio2DLayer, TextStudioAppearanceProperty, out string)

Section titled “TryRead(in TextStudio2DLayer, TextStudioAppearanceProperty, out string)”
public static bool TryRead(in TextStudio2DLayer layer, TextStudioAppearanceProperty property, out string authoredValue)

Attempts to format a supported layer property as an authored parameter value using culture-independent numeric formatting.

Parameters

NameType
layerTextStudio.TextStudio2DLayer
propertyTextStudio.TextStudioAppearanceProperty
authoredValueSystem.String

Returns

System.Boolean

TryWrite(in TextStudio2DLayer, TextStudioAppearanceProperty, string, out TextStudio2DLayer, out string)

Section titled “TryWrite(in TextStudio2DLayer, TextStudioAppearanceProperty, string, out TextStudio2DLayer, out string)”
public static bool TryWrite(in TextStudio2DLayer layer, TextStudioAppearanceProperty property, string value, out TextStudio2DLayer changed, out string error)

Attempts to parse and validate a typed parameter value, returning a changed layer or preserving the original with a diagnostic.

Parameters

NameType
layerTextStudio.TextStudio2DLayer
propertyTextStudio.TextStudioAppearanceProperty
valueSystem.String
changedTextStudio.TextStudio2DLayer
errorSystem.String

Returns

System.Boolean

TryGetTarget(in TextStudio2DLayer, TextStudioStackItemId, out TextStudio2DLayer)

Section titled “TryGetTarget(in TextStudio2DLayer, TextStudioStackItemId, out TextStudio2DLayer)”
public static bool TryGetTarget(in TextStudio2DLayer layer, TextStudioStackItemId treatmentId, out TextStudio2DLayer target)

Resolves a decoration treatment as a layer value, or returns the original layer when no treatment identity is supplied.

Parameters

NameType
layerTextStudio.TextStudio2DLayer
treatmentIdTextStudio.TextStudioStackItemId
targetTextStudio.TextStudio2DLayer

Returns

System.Boolean

public static IReadOnlyList<TextStudioAppearancePropertyDescriptor> All { get; }

Returns

System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioAppearancePropertyDescriptor}