TextStudioAppearanceActivation

StructTextStudioTextStudio

public struct TextStudioAppearanceActivation

Activation metadata for a top-level appearance group. Inactive source data is retained.

Methods

Inline(string, TextStudioAppearanceApplyMode)

public static TextStudioAppearanceActivation Inline(string id, TextStudioAppearanceApplyMode mode = TextStudioAppearanceApplyMode.Replace)

Creates a tagged inline appearance definition with the supplied identifier and application mode.

Parameters

Name	Type
id	System.String
mode	TextStudio.TextStudioAppearanceApplyMode

Returns

TextStudio.TextStudioAppearanceActivation

Reference(string, TextStudio2DStyleAsset, bool, TextStudioAppearanceApplyMode)

public static TextStudioAppearanceActivation Reference(string id, TextStudio2DStyleAsset asset, bool overrideMode = false, TextStudioAppearanceApplyMode mode = TextStudioAppearanceApplyMode.Replace)

Creates a tagged appearance definition referencing a style asset, optionally overriding its default application mode.

Parameters

Name	Type
id	System.String
asset	TextStudio.TextStudio2DStyleAsset
overrideMode	System.Boolean
mode	TextStudio.TextStudioAppearanceApplyMode

Returns

TextStudio.TextStudioAppearanceActivation

WithMode(TextStudioAppearanceActivationMode)

public TextStudioAppearanceActivation WithMode(TextStudioAppearanceActivationMode mode)

Returns an activation copy with the supplied always-active or tag-activated mode.

Parameters

Name	Type
mode	TextStudio.TextStudioAppearanceActivationMode

Returns

TextStudio.TextStudioAppearanceActivation

WithId(string)

public TextStudioAppearanceActivation WithId(string id)

Returns an activation copy with the supplied appearance tag identifier.

Parameters

Name	Type
id	System.String

Returns

TextStudio.TextStudioAppearanceActivation

WithSource(TextStudioAppearanceDefinitionSource, TextStudio2DStyleAsset)

public TextStudioAppearanceActivation WithSource(TextStudioAppearanceDefinitionSource source, TextStudio2DStyleAsset asset)

Returns an activation copy with the supplied inline or asset source and referenced asset.

Parameters

Name	Type
source	TextStudio.TextStudioAppearanceDefinitionSource
asset	TextStudio.TextStudio2DStyleAsset

Returns

TextStudio.TextStudioAppearanceActivation

WithApplyMode(TextStudioAppearanceApplyMode, bool)

public TextStudioAppearanceActivation WithApplyMode(TextStudioAppearanceApplyMode mode, bool overrideMode = true)

Returns an activation copy with the supplied application mode and asset-mode override behavior.

Parameters

Name	Type
mode	TextStudio.TextStudioAppearanceApplyMode
overrideMode	System.Boolean

Returns

TextStudio.TextStudioAppearanceActivation

WithExposures(TextStudioAppearanceExposure[])

public TextStudioAppearanceActivation WithExposures(TextStudioAppearanceExposure[] exposures)

Returns an activation copy with an independently copied array of exposed parameter bindings.

Parameters

Name	Type
exposures	TextStudio.TextStudioAppearanceExposure[]

Returns

TextStudio.TextStudioAppearanceActivation

Clone()

public TextStudioAppearanceActivation Clone()

Returns an activation copy with an independently copied exposure array.

Returns

TextStudio.TextStudioAppearanceActivation

IsValidId(string)

public static bool IsValidId(string id)

Checks for an identifier beginning with a letter or underscore and continuing with letters, digits, underscores, hyphens, periods, or colons.

Parameters

Name	Type
id	System.String

Returns

System.Boolean

Properties

Mode

public TextStudioAppearanceActivationMode Mode { get; }

Returns

TextStudio.TextStudioAppearanceActivationMode

Id

public string Id { get; }

Returns

System.String

Source

public TextStudioAppearanceDefinitionSource Source { get; }

Returns

TextStudio.TextStudioAppearanceDefinitionSource

Asset

public TextStudio2DStyleAsset Asset { get; }

Returns

TextStudio.TextStudio2DStyleAsset

OverrideApplyMode

public bool OverrideApplyMode { get; }

Returns

System.Boolean

ApplyMode

public TextStudioAppearanceApplyMode ApplyMode { get; }

Returns

TextStudio.TextStudioAppearanceApplyMode

Exposures

public TextStudioAppearanceExposure[] Exposures { get; }

Returns

TextStudio.TextStudioAppearanceExposure[]