UnitId 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 units.

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

Syntax

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

<SerializableAttribute>
<TypeConverterAttribute(GetType(UnitIdConverter))>
Public Structure UnitId
	Implements IUserSessionObject, IIdentifier, IConvertible, IEquatable(Of UnitId)

The UnitId type exposes the following members.

Constructors

	Name	Description
	UnitId(Int32)	Initializes a new instance of the UnitId class.
	UnitId(String)	Initializes a new instance of the UnitId class.
	UnitId(GuoidObject)	Initializes a new instance of the UnitId class.
	UnitId(ConnectionId, SessionId, GuoidObject)	Initializes a new instance of the UnitId class.
	UnitId(ConnectionId, SessionId, Int32)	Initializes a new instance of the UnitId class.
	UnitId(ConnectionId, SessionId, String)	Initializes a new instance of the UnitId class.

Top

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 unit id.
	IsResolved	Gets a value indicating whether this instance is resolved and Path, Id and Guoid contains values.
	Path	Gets or sets the path to the unit.
	SessionId	Gets or sets the session id.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(UnitId)	Indicates whether the current object is equal to another object of the same type.
	FromGuoid	Creates a new UnitId from its GuoidObject representation.
	FromInt32	Creates a new UnitId from its Int32 representation.
	FromPath	Creates a new UnitId from its path representation.
	GetHashCode	Returns the hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	(Inherited from Object.)
	InvalidateCache	Invalidates the cache.
	ToString	Returns a String that represents the current Object. (Overrides ValueTypeToString.)
	ToString(IFormatProvider)	Returns a String that represents this instance.
	TryParse	Converts the string representation of a number to its UnitId equivalent. A return value indicates whether the operation succeeded.

Top

Operators

	Name	Description
	(Int32 to UnitId)	Performs an implicit conversion from Int32 to UnitId.
	(String to UnitId)	Performs an implicit conversion from String to UnitId.
	(GuoidObject to UnitId)	Performs an implicit conversion from GuoidObject to UnitId.
	(UnitId to Int32)	Performs an implicit conversion from UnitId to Int32.
	(UnitId to GuoidObject)	Performs an implicit conversion from UnitId to GuoidObject.

Top

Reference

ContentStudio.Document Namespace