BlueprintMultiLanguageText Class
A multi-language text used inside the model customization
Definition
Namespace: Articy.Api.ObjectCustomization
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public sealed class BlueprintMultiLanguageText : BlueprintMultiLanguageTextBase- Inheritance
- Object BlueprintMultiLanguageTextBase BlueprintMultiLanguageText
Constructors
| BlueprintMultiLanguageText | Create an empty multi-language text |
| BlueprintMultiLanguageText(String) | Create a new multi-language text with the given text as the CCL entry |
Properties
| AudioSamples |
The dictionary of audio samples
(Inherited from BlueprintMultiLanguageTextBase) |
| CCL | Returns the content-creation-language, the primary language found in the articy ui |
| IsEmpty |
Checks if this multi-language text contains no entries in any language code
(Inherited from BlueprintMultiLanguageTextBase) |
| WasChanged | check if the value was changed in this blueprint session |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetAudioSample |
Returns the audio sample proxy for the given language code
(Inherited from BlueprintMultiLanguageTextBase) |
| GetEnumerator | Returns an enumerator that iterates through the collection. (Inherited from BlueprintMultiLanguageTextBase) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetText |
Returns the string for the given language code
(Inherited from BlueprintMultiLanguageTextBase) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasAudioSample |
Returns if an audio sample exist for the given language
(Inherited from BlueprintMultiLanguageTextBase) |
| SetAudioSample(ApiLanguageInfo, ObjectProxy) | Set an audio sample for the given language |
| SetAudioSample(Int32, ObjectProxy) | Set an audio sample for the given language |
| SetFromTpkLocalizationId | Use this if you want the value of the text be automatically filled by all language entries in your tpk file, with the given localization id |
| SetText(String) | Set a text for the CCL (or primary) language |
| SetText(ApiLanguageInfo, String) | Set a text for the given language |
| SetText(Int32, String) | Set a text for the given language |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetAudioSample |
Safe check if the multi-language text contains an audio sample entry for the given language
(Inherited from BlueprintMultiLanguageTextBase) |
| TryGetText |
Safe check if the multi-language text contains an entry for the given language
(Inherited from BlueprintMultiLanguageTextBase) |
Operators
| (BlueprintMultiLanguageText to String) | Implicitly cast a multi-language text to a string, using the primary language. |
| (String to BlueprintMultiLanguageText) | Implicit conversion from string to a multi-language text, will store the string as the primary language. |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |