Represents a document.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.Artifact
kCura.Relativity.Client.DTOs.Document
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The Document type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Document() |
Initializes a new instance of the Document class.
|
![]() | Document(Int32) |
Initializes a new instance of the Document class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | ArtifactID |
Represents a unique identifier for an Artifact.
(Inherited from Artifact.) |
![]() | ArtifactTypeGuids |
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.) |
![]() | ArtifactTypeID |
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.) |
![]() | ArtifactTypeName |
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.) |
![]() | Batch |
Indicates the batch that the document is assigned to.
|
![]() | Batch_AssignedTo |
Indicates the user assigned to the batch that contains this document.
|
![]() | Batch_BatchSet |
Indicates the batch set that the document is assigned to.
|
![]() | Batch_Status |
Indicates the status of the batch.
|
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | FileIcon |
Represents the file icon associated with the document.
|
![]() | FolderName |
Indicates the name of the folder in Relativity, where the document is located.
|
![]() | Guids |
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.) |
![]() | HasImages |
Indicates whether images of the document exist.
|
![]() | HasInlineTags |
Indicates whether inline tags have been applied to the document.
|
![]() | HasNative |
Indicates whether a native file exists for the document.
|
![]() | ImageQCStatus |
Indicates whether the document's images, if any exist, are hidden for QC review.
|
![]() | Item[Guid] |
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[Int32] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[String] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.) |
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | RelativityImageCount |
Provides the number of images associated with a document.
|
![]() | RelativityNativeFileLocation |
Specifies the local path for the native file.
|
![]() | RelativityNativeTimeZoneOffset |
Indicates the native time zone offset of the document.
|
![]() | RelativityNativeType |
Indicates the type of native file for a document.
|
![]() | SupportedByViewer |
Indicates whether the Relativity viewer supports the native file type of a document.
|
![]() | SystemCreatedBy |
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemCreatedOn |
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedBy |
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedOn |
Represents the DateTime in UTC when the Artifact was last modified. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | TextIdentifier |
Indicates the value of the IdentifierFieldName field available in Fields property of the Artifact.
This field may also be available as a Name property for many Artifacts.
(Inherited from Artifact.) |
![]() | TimeZoneField |
Lists the ArtifactID representing the time zone of the document.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString |
Returns a string that represents the current Artifact.
(Inherited from Artifact.) |
Remarks
See Also