Class DWriteLocalizedStrings
Represents a collection of strings indexed by locale name.
Inherited Members
Namespace: JeremyAnsel.DirectX.DWrite
Assembly: JeremyAnsel.DirectX.DWrite.dll
Syntax
public sealed class DWriteLocalizedStrings : IDisposable, IDWriteReleasable
Properties
| Edit this page View SourceHandle
Gets an handle representing the DWrite object interface.
Declaration
public object Handle { get; }
Property Value
| Type | Description |
|---|---|
| object |
Methods
| Edit this page View SourceDispose()
Immediately releases the unmanaged resources used by the DWrite object.
Declaration
[SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Usage", "CA1816:CallGCSuppressFinalizeCorrectly", Justification = "Reviewed")]
public void Dispose()
FindLocaleName(string, out uint)
Gets the index of the item with the specified locale name.
Declaration
[SuppressMessage("Microsoft.Design", "CA1021:AvoidOutParameters", MessageId = "1#", Justification = "Reviewed")]
public bool FindLocaleName(string localeName, out uint index)
Parameters
| Type | Name | Description |
|---|---|---|
| string | localeName | Locale name to look for. |
| uint | index | Receives the zero-based index of the locale name/string pair. |
Returns
| Type | Description |
|---|---|
| bool | TRUE if the locale name exists or FALSE if not. |
GetCount()
Gets the number of language/string pairs.
Declaration
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Reviewed")]
public uint GetCount()
Returns
| Type | Description |
|---|---|
| uint |
GetLocaleName(uint)
Copies the locale name with the specified index to the specified array.
Declaration
public string GetLocaleName(uint index)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | index | Zero-based index of the locale name. |
Returns
| Type | Description |
|---|---|
| string |
GetString(uint)
Copies the string with the specified index to the specified array.
Declaration
public string GetString(uint index)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | index | Zero-based index of the string. |
Returns
| Type | Description |
|---|---|
| string |
Release()
Releases the managed reference to the COM DWrite interface.
Declaration
public void Release()
ToBoolean()
Gets a boolean indicating if the handle is not null.
Declaration
public bool ToBoolean()
Returns
| Type | Description |
|---|---|
| bool | A boolean |
Operators
| Edit this page View Sourceimplicit operator bool(DWriteLocalizedStrings?)
Gets a boolean indicating if the handle is not null.
Declaration
public static implicit operator bool(DWriteLocalizedStrings? value)
Parameters
| Type | Name | Description |
|---|---|---|
| DWriteLocalizedStrings | value | A DWrite object. |
Returns
| Type | Description |
|---|---|
| bool | A boolean |