Show / Hide Table of Contents

Class CategoryField

Represents a field in the SaveFieldsAndCustomTextRequest.

Inheritance
System.Object
CategoryField
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 CategoryField

Properties

| Improve this Doc View Source

AllowCopyFromPrevious

Gets or sets a value indicating whether to allow copy from previous.

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

AllowHtml

Gets or sets a value indicating whether to allow HTML.

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

CategoryID

Gets or sets the artifact id of the Category.

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

Colspan

Gets or sets the colspan of the field.

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

Column

Gets or sets the column to place the field in. Defaults to 1, the first column.

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

DefaultValue

Gets or sets the default value.

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

DisplayName

Gets or sets the display name of the field.

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

ElementType

Gets the LayoutElementType.

Declaration
public LayoutElementType ElementType { get; }
Property Value
Type Description
LayoutElementType
| Improve this Doc View Source

FieldArtifactID

Gets or sets the artifact id of the field.

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

FieldCategoryID

Gets or sets the artifact id of the FieldCategory.

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

FieldDisplayType

Gets or sets the FieldDisplayType of the field.

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

FieldTypeID

Gets or sets the FieldType of the field.

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

FullTextFieldHeight

Gets or sets the height of the full text field.

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

IsArtifactBaseField

Gets or sets a value indicating whether the artifact is a base field.

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

IsEdited

Gets or sets a value indicating whether this is edited.

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

IsReadOnly

Gets or sets a value indicating whether the field is read only.

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

IsRequired

Gets or sets a value indicating whether the field is required.

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

LayoutArtifactID

Gets or sets the artifact id of the Layout.

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

NameValue

Gets or sets the name value.

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

ObjectType

Gets or sets the artifact id of the object type.

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

Order

Gets or sets the order.

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

PickerViewArtifactID

Gets or sets the artifactID of the PickerView.

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

RepeatColumn

Gets or sets the repeat column.

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

Row

Gets or sets the row to place the field in.

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

Rows

Gets or sets the number of rows. Defaults to 1.

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

ShowNameColumn

Gets or sets a value indicating whether to show the name column. Defaults to true.

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

TempID

Gets or sets the TempID.

Declaration
public long TempID { get; set; }
Property Value
Type Description
System.Int64
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX