Class LocalizedDescriptionAttribute
LocalizedDescriptionAttribute is a localizable descendant of the System.ComponentModel.DescriptionAttribute. The string value of this class can be used either as literal or as resource identifier into a specified ResourceType
Inheritance
Inherited Members
Namespace: MediaBrowser.Model.LocalizationAttributes
Assembly: MediaBrowser.Model.dll
Syntax
public class LocalizedDescriptionAttribute : DescriptionAttribute
Constructors
LocalizedDescriptionAttribute()
Initializes a new instance of the System.ComponentModel.DescriptionAttribute class with no parameters.
Declaration
public LocalizedDescriptionAttribute()
LocalizedDescriptionAttribute(String)
Initializes a new instance of the System.ComponentModel.DescriptionAttribute class with a description.
Declaration
public LocalizedDescriptionAttribute(string description)
Parameters
Type | Name | Description |
---|---|---|
System.String | description | The description text. |
LocalizedDescriptionAttribute(String, Type)
Initializes a new instance of the System.ComponentModel.DescriptionAttribute class with a description.
Declaration
public LocalizedDescriptionAttribute(string description, [ResourceType] Type resourceType)
Parameters
Type | Name | Description |
---|---|---|
System.String | description | The description resource key. |
System.Type | resourceType | Type of the resource. |
Properties
Description
Gets the UI display string for Description.
This can be either a literal, non-localized string provided to Description or the localized string found when ResourceType has been specified and Description represents a resource key within that resource type.
Declaration
public override string Description { get; }
Property Value
Type | Description |
---|---|
System.String | When ResourceType has not been specified, the value of Description will be returned. When ResourceType has been specified and Description represents a resource key within that resource type, then the localized value will be returned. |
Overrides
ResourceType
Gets or sets the System.Type that contains the resources for Description.
Declaration
[ResourceType]
public Type ResourceType { get; set; }
Property Value
Type | Description |
---|---|
System.Type |