DocumentId Structure Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This class is used for identification of Content Studio documents.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

[SerializableAttribute]
[TypeConverterAttribute(typeof(DocumentIdConverter))]
public struct DocumentId : IUserSessionObject, 
	IIdentifier, IConvertible, IEquatable<DocumentId>

The DocumentId type exposes the following members.

Constructors

  NameDescription
Public methodDocumentId(Int32)
Initializes a new instance of the DocumentId class.
Public methodDocumentId(String)
Initializes a new instance of the DocumentId class.
Public methodDocumentId(GuoidObject)
Initializes a new instance of the DocumentId class.
Public methodDocumentId(ConnectionId, SessionId, GuoidObject)
Initializes a new instance of the DocumentId class.
Public methodDocumentId(ConnectionId, SessionId, Int32)
Initializes a new instance of the DocumentId class.
Public methodDocumentId(ConnectionId, SessionId, String)
Initializes a new instance of the DocumentId class.
Top
Properties

  NameDescription
Public propertyConnectionId
Gets or sets the connection id.
Public propertyGuoid
Gets or sets the guoid.
Public propertyHasValue
Gets a value indicating whether this instance has value specified.
Public propertyId
Gets or sets the document id.
Public propertyIsResolved
Gets a value indicating whether this instance is resolved and Path, Id, Guoid and VirtualPath contains values.
Public propertyPath
Gets or sets the path to the document.
Public propertySessionId
Gets or sets the session id.
Public propertyVirtualPath
Gets the virtual path for this document item.
Top
Methods

  NameDescription
Public methodEquals(Object) (Inherited from ValueType.)
Public methodEquals(DocumentId)
Indicates whether the current object is equal to another object of the same type.
Public methodStatic memberFromGuoid
Creates a new DocumentId from its GuoidObject representation.
Public methodStatic memberFromInt32
Creates a new DocumentId from its Int32 representation.
Public methodStatic memberFromPath
Creates a new DocumentId from its path representation.
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetType (Inherited from Object.)
Public methodInvalidateCache
Invalidates the cache.
Public methodToString
Returns a String that represents the current Object.
(Overrides ValueTypeToString.)
Public methodToString(IFormatProvider)
Returns a String that represents this instance.
Public methodStatic memberTryParse
Converts the string representation of a number to its DocumentId equivalent. A return value indicates whether the operation succeeded.
Public methodStatic memberTryResolve
Tries to resolve the string representation to its DocumentId equivalent. A return value indicates whether the string could be resolved to a document.
Top
Operators

  NameDescription
Public operatorStatic member(Int32 to DocumentId)
Performs an implicit conversion from Int32 to DocumentId.
Public operatorStatic member(String to DocumentId)
Performs an implicit conversion from String to DocumentId.
Public operatorStatic member(DocumentId to Int32)
Performs an implicit conversion from DocumentId to Int32.
Public operatorStatic member(DocumentId to GuoidObject)
Performs an implicit conversion from DocumentId to GuoidObject.
Public operatorStatic member(GuoidObject to DocumentId)
Performs an implicit conversion from GuoidObject to DocumentId.
Top
See Also

Reference