One of the key properties in the Placeholder structure is the Definition object. So important and unique is this object that we provide the parentage of the PlaceholderDefinition in the following tables. The CanCache, InjectTypeProperty, and ReflectAsReadOnly properties inherited from CustomReflectableObject are protected and must be overridden to use them, so we left them out of the tables. Likewise, the protected properties GetEditor and GetPropertyOwner are not intended to be used directly from code and are also left out of the tables.
Table B-11 shows the complete parentage of the CMS Placeholder Definition class, using the same rules as the Placeholder table.
Table B-12 defines all the members listed for the Placeholder Definition class in Table B-11.
Again, the classification column in Table B-12 is not a CMS classification. It was included to make it easier to locate the discussion about each member in Chapter 27.
Table B-12. PlaceholderDefinition Member Descriptions
Placeholder | Classification | Description |
|---|
Public Properties |
Description | Read/write | Gets or sets a description for the PlaceholderDefinition. |
IsReadOnly | Read-only | Indicates whether the Placeholder Definition is read-only. |
Name | Read/write | Gets or sets the name of a PlaceholderDefinition. |
Public Methods | | |
Clone | Creating and deleting | Creates a new Placeholder Definition object that is a copy of the current PlaceholderDefinition. |
CreatePlaceholder | Creating and deleting | Creates a new Placeholder based on this PlaceholderDefinition. |
Delete | Creating and deleting | Marks a PlaceholderDefinition as deleted and removes it from the Template to which it belongs. |
DeserializeObject | Creating and deleting | Deserializes the Placeholder Definition contained in a System.Xml.XmlNode. |
Equals | System | Determines whether two Object instances are equal. |
GetAttributes | Read-only | Gets the collection of attributes for the PlaceholderDefinition. |
GetClassName | Read-only | Gets the name of the class for the PlaceholderDefinition. |
GetComponentName | Read-only | Gets the name of the component for the PlaceholderDefinition. |
GetConverter | Read-only | Gets a .NET converter for use with the PlaceholderDefinition. Converters are primarily used for string-to-value conversions, and they themselves have a multitude of members. |
GetDefaultEvent | Read-only | Gets the default event for a PlaceholderDefinition, if any. |
GetDefaultProperty | Read-only | Gets the default property for a PlaceholderDefinition, if any. |
GetEvents | Read-only | Gets the events that are declared or inherited by the Placeholder Definition. |
GetHashCode | Read-only | Gets the hash code for the object. |
GetProperties | Read-only | Gets the collection of properties for the PlaceholderDefinition. |
GetType | Read-only | Gets the Type of the current instance. |
Serialize | Creating and deleting | Serializes the Placeholder Definition to an XML string using an optional System.Xml.XmlWriter. |
ToString | System | Returns a String that represents the current object type. |
Public Events |
PropertyChanged | Creating and deleting | Occurs after any property of a PlaceholderDefinition has changed. |
Public Constructors |
Placeholder Definition Constructor | Creating and deleting | Is the constructor for the PlaceholderDefinition class. |
Protected Methods |
BeginRead | Other | Checks that neither the current PlaceholderDefinition nor the Template to which the Placeholder Definition belongs has been deleted and committed. |
BeginWrite | Other | Checks that the current user has sufficient rights to edit the PlaceholderDefinition. |
EndWrite | Other | Saves the most recent change made to a PlaceholderDefinition to the CMS server. |
OnCloned | Other | Allows a custom placeholder definition (derived from Placeholder Definition) to perform custom actions when an instance is cloned. |
