ITextStudioVisibility

InterfaceTextStudioTextStudio

public interface ITextStudioVisibility

Focused runtime visibility contract. Visibility overrides never change authored markup.

Methods

SetTextVisibility(bool, bool)

bool SetTextVisibility(bool visible, bool playTransition = false)

Overrides visibility for the complete text without modifying its markup.

Parameters

Name	Type	Description
visible	System.Boolean	Whether all glyphs should be visible.
playTransition	System.Boolean	Whether configured reveal or hide transitions should be used.

Returns

System.Boolean: true when the override was accepted.

SetWordVisibility(int, bool, bool)

bool SetWordVisibility(int wordIndex, bool visible, bool playTransition = false)

Overrides visibility for one semantic word.

Parameters

Name	Type	Description
wordIndex	System.Int32	Zero-based word index in the current compiled plan.
visible	System.Boolean	Whether glyphs in the word should be visible.
playTransition	System.Boolean	Whether configured transitions should be used.

Returns

System.Boolean: false when wordIndex is outside the current plan.

SetGlyphVisibility(int, bool, bool)

bool SetGlyphVisibility(int glyphIndex, bool visible, bool playTransition = false)

Overrides visibility for one visible glyph.

Parameters

Name	Type	Description
glyphIndex	System.Int32	Zero-based visible-glyph index in the current compiled plan.
visible	System.Boolean	Whether the glyph should be visible.
playTransition	System.Boolean	Whether configured transitions should be used.

Returns

System.Boolean: false when glyphIndex is outside the current plan.

ClearGlyphVisibilityOverride(int)

bool ClearGlyphVisibilityOverride(int glyphIndex)

Restores authored visibility for one glyph.

Parameters

Name	Type	Description
glyphIndex	System.Int32	Zero-based visible-glyph index in the current compiled plan.

Returns

System.Boolean: true when an existing override was removed.

ClearVisibilityOverrides()

bool ClearVisibilityOverrides()

Restores authored visibility for every glyph.

Returns

System.Boolean: true when at least one override was removed.

Properties

HasVisibilityOverrides

bool HasVisibilityOverrides { get; }

Gets whether any runtime visibility override currently differs from authored visibility.

Returns

System.Boolean