Skip to content

TextStudioStackItemId

StructTextStudioTextStudio
public struct TextStudioStackItemId

Stable serialized identity shared by Text Studio appearance-stack items.

public static TextStudioStackItemId Create(string value)

Creates a validated identifier or throws when the value is malformed.

Parameters

Name Type
value System.String

Returns

TextStudio.TextStudioStackItemId

public static TextStudioStackItemId CreateUnique(string itemNamespace)

Creates a new authoring identity in the supplied namespace.

Parameters

Name Type
itemNamespace System.String

Returns

TextStudio.TextStudioStackItemId

TryCreate(string, out TextStudioStackItemId)

Section titled “TryCreate(string, out TextStudioStackItemId)”
public static bool TryCreate(string value, out TextStudioStackItemId id)

Attempts to create a canonical identifier without throwing.

Parameters

Name Type
value System.String
id TextStudio.TextStudioStackItemId

Returns

System.Boolean

public static bool IsCanonical(string value)

Returns true when a string follows the stable namespaced ID grammar.

Parameters

Name Type
value System.String

Returns

System.Boolean

public bool Equals(TextStudioStackItemId other)

Parameters

Name Type
other TextStudio.TextStudioStackItemId

Returns

System.Boolean

public override bool Equals(object obj)

Parameters

Name Type
obj System.Object

Returns

System.Boolean

public override int GetHashCode()

Returns

System.Int32

public override string ToString()

Returns

System.String

operator ==(TextStudioStackItemId, TextStudioStackItemId)

Section titled “operator ==(TextStudioStackItemId, TextStudioStackItemId)”
public static bool operator ==(TextStudioStackItemId left, TextStudioStackItemId right)

Reports whether both values identify the same persistent stack item.

Parameters

Name Type
left TextStudio.TextStudioStackItemId
right TextStudio.TextStudioStackItemId

Returns

System.Boolean

operator !=(TextStudioStackItemId, TextStudioStackItemId)

Section titled “operator !=(TextStudioStackItemId, TextStudioStackItemId)”
public static bool operator !=(TextStudioStackItemId left, TextStudioStackItemId right)

Reports whether the values identify different persistent stack items.

Parameters

Name Type
left TextStudio.TextStudioStackItemId
right TextStudio.TextStudioStackItemId

Returns

System.Boolean

public string Value { get; }

Canonical namespaced identifier.

Returns

System.String

public bool IsValid { get; }

Whether the identifier is canonical and safe to persist.

Returns

System.Boolean