Class View

Represents the view object type.

Inheritance
System.Object
Artifact
NamedArtifact
View
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
public class View : NamedArtifact, IHasName, IFillsRequiredProperties<View>

Properties

| Improve this Doc View Source

ArtifactTypeId

Gets or sets the artifact type ID.

Declaration
[FieldName("ArtifactTypeID")]
public int ArtifactTypeId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Dashboard

Gets or sets a dashboard object contains properties that include the Artifact ID of the dashboard, its name, and a list of GUIDs associated with it.

Declaration
public NamedArtifact Dashboard { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

Fields

Gets or sets the fields to be included in the view result set. This fields are specified as a collection of Fields objects. You must include at least one field in the view.

Declaration
public NamedArtifact[] Fields { get; set; }
Property Value
Type Description
NamedArtifact[]
| Improve this Doc View Source

GroupDefinitionFieldArtifactId

Gets or sets group definition field artifactID associated with the view.

Declaration
[FieldName("GroupDefinitionFieldArtifactID")]
public string GroupDefinitionFieldArtifactId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsRelationalFieldView

Gets or sets a value indicating whether the view is used to display relational fields. The default value is false.

Declaration
public bool IsRelationalFieldView { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsSystemView

Gets or sets a value indicating whether the view is a system view. Relativity contains system views that are provided as part of the application by default. You can't edit all system views, such as the workspace system view. The default value is false.

Declaration
public bool IsSystemView { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsVisible

Gets or sets a value indicating whether the view is visible in the system. The default value is true.

Declaration
public bool IsVisible { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ObjectType

Gets or sets the artifact type information for the object that the view is assigned to.

Declaration
public NamedArtifact ObjectType { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

Order

Gets or sets the position of the view in the view drop-down list.

Declaration
public int Order { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Owner

Gets or sets the user who owns the view. The default value is langword_csharp_Public.

Declaration
public NamedArtifact Owner { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

QueryHint

Gets or sets a string parameter used to optimize the view.

Declaration
public string QueryHint { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RelativityApplications

Gets or sets the relativity applications associated with the view.

Declaration
public List<NamedArtifact> RelativityApplications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<NamedArtifact>
| Improve this Doc View Source

SearchCriteria

Gets or sets the search criteria specified as a CriteriaCollection object. This object contains the list of conditions specified in the query.

Declaration
public CriteriaCollection SearchCriteria { get; set; }
Property Value
Type Description
CriteriaCollection
| Improve this Doc View Source

Sorts

Gets or sets the sort order for view results specified as a collection of Sort objects. This field indicates whether the results are sorted in ascending or descending order, identifies a field by Artifact ID and GUID, and specifies a sort order.

Declaration
public List<Sort> Sorts { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Sort>
| Improve this Doc View Source

SystemCreatedBy

Gets or sets the user who created the view. The user is identified with a name and Artifact ID.

Declaration
public NamedArtifact SystemCreatedBy { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

SystemCreatedOn

Gets or sets the date and time in UTC when the view was created.

Declaration
public DateTime? SystemCreatedOn { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

SystemLastModifiedBy

Gets or sets the user who last modified the view.

Declaration
public NamedArtifact SystemLastModifiedBy { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

SystemLastModifiedOn

Gets or sets the date and time in UTC when the view was last modified.

Declaration
public DateTime? SystemLastModifiedOn { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

VisibleInDropdown

Gets or sets a value indicating whether the view is visible in the view drop-down list. The default value is false.

Declaration
public bool VisibleInDropdown { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

FillRequiredProperties()

Fills the required properties.

Declaration
public View FillRequiredProperties()
Returns
Type Description
View

The same View object instance.

Implements