Tab Class

Relativity Services API
Represents a tab in Relativity.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.Artifact
    kCura.Relativity.Client.DTOs.Tab

Namespace:  kCura.Relativity.Client.DTOs
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class Tab : Artifact

The Tab type exposes the following members.

Constructors

  NameDescription
Public methodTab()
Creates a new instance of the Tab class.
Public methodTab(Int32)
Initializes a new instance of the Tab 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 propertyExternalLink
Provides a URL with the full web address for a tab with LinkType set to External.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyIsDefault
Indicates whether the tab is the default workspace tab.
Public propertyIsVisible
Indicates whether the tab is visible in Relativity.
Public propertyItem[Guid]
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[Int32]
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[String]
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.)
Public propertyLinkType
Indicates the type of the tab.
Public propertyName
Represents the name of the tab.
Public propertyObjectType
Represents the object type of the items displayed on the tab in Relativity.
Public propertyOrder
Uses numerical value to indicate the position of the tab.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyRelativityApplications
Represents a Multiple Object field specifying Relativity Application objects associated with this Tab.
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 propertyTabDisplay
Indicates how the tab is displayed.
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.)
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 Tab DTO supports the read and query operations.
See Also

Reference