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

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

Gets the directives that are applicable for a particular Content Studio file system object.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public DirectiveControlDirectiveClass[] GetDirectivesApplicable(
	ConnectionId connectionId,
	SessionId sessionId,
	int objectId,
	CSFileObjectTypes objectType
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
objectId
Type: SystemInt32
The object to get directives for.
objectType
Type: ContentStudio.DocumentCSFileObjectTypes
The type of Content Studio object referenced by the objectId parameter

Return Value

Type: DirectiveControlDirectiveClass
A list of DirectiveControlDirectiveClass objects that describes directives applicable for a particular Content Studio file system object
Content Studio permissions
No special permission is required to successfully call this GetDirectivesApplicable.
Remarks

This method is new in Content Studio 5.4.

This method calculates the type of object being specified to determine which directives are applicable with the object specified. Some types of object categories and documents cannot have directives, this includes

  • Uploaded files
  • Active Scripting
  • Ept documents
  • Documents that are not User controls, Master pages or Aspx documents

For regular documents, the following restrictions applies

Master pages (file extension .master) cannot have
Page
Control
User controls (file extension .ascx) cannot have
Page
Master
Regular documents (file extension .aspx) cannot have
Control
Master
Other document types do not have any directives

Units and the Site root have no restrictions.

Documents and categories that are located or are children of any of the protected system categories cannot have directives. These are:

  • System/Assemblies
  • System/App_Data
  • System/App_Code
  • System/App_Themes
  • System/App_GlobalResources
  • System/App_Browsers
See Also

Reference

DirectiveControl Class
ContentStudio.Document Namespace