Class DisplayOption
A Display option can be used to register different display options on a content inside a content area
Inheritance
Inherited Members
Namespace: EPiServer.Web
Assembly: EPiServer.dll
Version: 11.20.7Syntax
public class DisplayOption : IReadOnly<DisplayOption>, IReadOnly
Constructors
DisplayOption()
Declaration
public DisplayOption()
Properties
Description
Description for the display option
Declaration
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
If a language resource key is specified it will be automatically translated when sent to the client.
IconClass
Css class for the icon that is used in the display option selector
Declaration
public virtual string IconClass { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Id
Unique id for this option
Declaration
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
IsReadOnly
Indicates whether the current object instance is read-only.
Declaration
public bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
The name of the display option
Declaration
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
If a language resource key is specified it will be automatically translated when sent to the client.
Tag
The rendering tag to apply when the option has been selected
Declaration
public virtual string Tag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
CreateWritableClone()
Creates a writable copy of the current object.
Declaration
public DisplayOption CreateWritableClone()
Returns
Type | Description |
---|---|
DisplayOption |
MakeReadOnly()
Changes the object instance into a read-only object.
Declaration
public void MakeReadOnly()
Explicit Interface Implementations
IReadOnly.CreateWritableClone()
Creates a writable copy of the current object.
Declaration
object IReadOnly.CreateWritableClone()
Returns
Type | Description |
---|---|
System.Object |