View Class

Relativity Services API
Represents a view, which uses a set of criteria to control the contents, fields, and sort order of items displayed on list pages in Relativity.
Inheritance Hierarchy

SystemObject
  kCura.Relativity.Client.DTOsArtifact
    kCura.Relativity.Client.DTOsView

Namespace:  kCura.Relativity.Client.DTOs
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax

public class View : Artifact

The View type exposes the following members.

Constructors

  NameDescription
Public methodView
Creates a new instance of the View class.
Public methodView(Int32)
Initializes a new instance of the View class with the given ArtifactID.
Top
Properties

  NameDescription
Public propertyArtifactID
Represents a unique identifier for an Artifact.
(Inherited from Artifact.)
Public propertyArtifactTypeGuids
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.)
Public propertyArtifactTypeID
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.)
Public propertyArtifactTypeName
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.)
Public propertyDashboardID
Artifact ID representing a Dashboard linked to the View.
Public propertyDisplayField
Indicates the settings for indentations used to display email threads, which is defined by the IndentationDefinitionField property.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyGroupDefinitionField
Represents a field that is common across a group of email messages.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyIndentationDefinitionField
Includes logic for displaying indented lists.
Public propertyIsVisible
Indicates whether a view is visible in a drop-down list box.
Public propertyItemGuid
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.)
Public propertyItemInt32
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.)
Public propertyItemString
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.)
Public propertyName
Represents the name of a view as a string.
Public propertyObjectType
Represents the type of object that is displayed in a view.
Public propertyOrder
Indicates the sorting order assigned to a view.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyRelativityApplications
Represents the Relativity applications associated with this view.
Public propertyRenderLinks
Determines whether links in the view are rendered in the Relativity web UI.
Public propertySystemCreatedBy
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemCreatedOn
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedBy
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedOn
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.)
Public propertyTextIdentifier
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.)
Public propertyVisibleInDropdown
Determines whether the view is available on a tab containing the specified object type.
Public propertyVisualizationType
Determines whether the view displays items in the standard or indented list format.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current Artifact.
(Inherited from Artifact.)
Top
Remarks

The View class supports read and query operations.
See Also

Reference