Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
DELETE permission is required on the document to be moved and CREATE permission is required on the target.
[This is preliminary documentation and is subject to change.]
Moves a document within a document hierarchy or inserts it into a document hierarchy.
This method can either change the order within the same level or move the document to another level.
Parent documents cannot be moved to one of its children.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void MoveDocumentInHierarchy( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, DocumentId targetDocumentId, bool createChild )
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). - documentId
- Type: ContentStudio.DocumentDocumentId
The document to move - targetDocumentId
- Type: ContentStudio.DocumentDocumentId
The document to move the document to. If the createChild parameter is true the document will be set as a child document of targetDocumentId otherwise the document will be ordered before targetDocumentId on the same level. To remove a document from the hierarchy targetDocumentId must be set to documentId. - createChild
- Type: SystemBoolean
Set to true to indicate that the document should be added as a child document to targetDocumentId rather than a sibling placed before.
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also