Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
Top
[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
Name | Description | |
---|---|---|
DocumentId(Int32) |
Initializes a new instance of the DocumentId class.
| |
DocumentId(String) |
Initializes a new instance of the DocumentId class.
| |
DocumentId(GuoidObject) |
Initializes a new instance of the DocumentId class.
| |
DocumentId(ConnectionId, SessionId, GuoidObject) |
Initializes a new instance of the DocumentId class.
| |
DocumentId(ConnectionId, SessionId, Int32) |
Initializes a new instance of the DocumentId class.
| |
DocumentId(ConnectionId, SessionId, String) |
Initializes a new instance of the DocumentId class.
|
Properties
Name | Description | |
---|---|---|
ConnectionId |
Gets or sets the connection id.
| |
Guoid |
Gets or sets the guoid.
| |
HasValue |
Gets a value indicating whether this instance has value specified.
| |
Id |
Gets or sets the document id.
| |
IsResolved |
Gets a value indicating whether this instance is resolved and Path, Id, Guoid and VirtualPath contains values.
| |
Path |
Gets or sets the path to the document.
| |
SessionId |
Gets or sets the session id.
| |
VirtualPath |
Gets the virtual path for this document item.
|
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from ValueType.) | |
Equals(DocumentId) |
Indicates whether the current object is equal to another object of the same type.
| |
FromGuoid |
Creates a new DocumentId from its GuoidObject representation.
| |
FromInt32 |
Creates a new DocumentId from its Int32 representation.
| |
FromPath |
Creates a new DocumentId from its path representation.
| |
GetHashCode |
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.) | |
GetType | (Inherited from Object.) | |
InvalidateCache |
Invalidates the cache.
| |
ToString | (Overrides ValueTypeToString.) | |
ToString(IFormatProvider) |
Returns a String that represents this instance.
| |
TryParse |
Converts the string representation of a number to its DocumentId equivalent. A return value indicates whether the operation succeeded.
| |
TryResolve |
Tries to resolve the string representation to its DocumentId equivalent. A return value indicates whether the string could be resolved to a document.
|
Operators
Name | Description | |
---|---|---|
(Int32 to DocumentId) |
Performs an implicit conversion from Int32 to DocumentId.
| |
(String to DocumentId) |
Performs an implicit conversion from String to DocumentId.
| |
(DocumentId to Int32) |
Performs an implicit conversion from DocumentId to Int32.
| |
(DocumentId to GuoidObject) |
Performs an implicit conversion from DocumentId to GuoidObject.
| |
(GuoidObject to DocumentId) |
Performs an implicit conversion from GuoidObject to DocumentId.
|
See Also