DirectiveControlGetDirectiveInformation Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets a list of available page directive attributes, their values and description

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetDirectiveInformation(
	DirectiveControlDirectiveClass dirClass
)

Parameters

dirClass
Type: ContentStudio.DocumentDirectiveControlDirectiveClass
The directive to retrieve information for

Return Value

Type: String
Xml
Examples
Copy
<directive>
  <attributes>
   <attribute name="Name of the attribute" description="Description and usage">
     <!--The type attribute below can be either "enum" for fixed values or "text" for text values -->
     <values type="enum" optional="false">
       <value default="true" value="false" />
       <value default="false" value="true" />
     </values>
   </attribute>
  </attributes>
</directive>
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionThe Directive class argument is out of the range of valid values
SecurityExceptionContent Studio runtime does not have permission to read the xml file that defines the data.
FileNotFoundExceptionAn error occurred when Content Studio tried to find the xml file that defines directive attributes
Content Studio permissions
Any authenticated user can successfully execute this method. Anonymous callers are supported.
See Also

Reference

DirectiveControl Class
ContentStudio.Document Namespace