Server APIs – Aras.TreeGridView.Model

Aras.TreeGridView v12.0.0.17204

• ColumnDefinition
• ColumnMapping
• GenerateViewArguments
• IQueryItemResult
• LocalStyle
• LocalStyleDefinition
• QueryDefinition
• QueryItemResult
• ReferenceType
• RowContextData
• ShowMoreOffsetInfo
• TreeCell
• TreeCellStyle
• TreeGridViewDefinition
• TreeGridViewDefinitionFactory
• TreeRow
• TreeRowDefinition
• TreeRowItem
• TreeRowItemData
• TreeRowReference

ColumnDefinition Class

Inheritance object → ColumnDefinition

public class ColumnDefinition
{
  // Constructors
  public ColumnDefinition(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_ColumnDefinition"

  // Properties
  public string BuilderMethod { get; }
  public string CellViewType { get; }
  public ICollection<ColumnMapping> ColumnMappings { get; }
  public string DataTemplate { get; }
  public string Header { get; }
  public string HeaderStyleRefId { get; }
  public string Name { get; }
  public int PositionOrder { get; }
  public string SourceId { get; }
  public string StyleRefId { get; }
  public string Template { get; }
  public int Width { get; }
}

ColumnMapping Class

Inheritance object → ColumnMapping

public class ColumnMapping
{
  // Constructors
  public ColumnMapping(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_ColumnMapping"

  // Properties
  public string BuilderMethod { get; }
  public string CellViewType { get; }
  public string DataTemplate { get; }
  public string SourceId { get; }
  public string Template { get; }
  public string TreeRowRefId { get; }
}

GenerateViewArguments Class

Inheritance object → GenerateViewArguments

public class GenerateViewArguments
{
  // Constructors
  public GenerateViewArguments();

  // Properties
  public int? CurrentFetch { get; set; }
  public Innovator Innovator { get; set; }
  public int LevelsToExpand { get; set; }
  public RowContextData RowContextData { get; set; }
  public ShowMoreOffsetInfo ShowMoreOffsetInfo { get; set; }
  public Dictionary<string, string[]> StartCondition { get; set; }
}

IQueryItemResult Interface

public interface IQueryItemResult
{

  // Properties
  public string ItemId { get; }
  public string QueryAlias { get; }
  public string QueryReferencePath { get; }

  // Methods
  public string GetProperty(string name);
  public string GetPropertyAttribute(string propertyName, string attributeName);
}

LocalStyle Class

Inheritance object → LocalStyle

public class LocalStyle
{
  // Constructors
  public LocalStyle(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_LocalStyle"

  // Properties
  public ICollection<LocalStyleDefinition> LocalStyleDefinitions { get; }
  public string Name { get; }
  public string RefId { get; }
  public string SourceId { get; }
}

LocalStyleDefinition Class

Inheritance object → LocalStyleDefinition

public class LocalStyleDefinition
{
  // Constructors
  public LocalStyleDefinition(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_LocalStyleDefinition"

  // Properties
  public string Justification { get; }
  public string SourceId { get; }
}

QueryDefinition Class

Inheritance object → QueryDefinition

public class QueryDefinition
{
  // Constructors
  public QueryDefinition();

  // Properties
  public Item ItemModified { get; }

  // Methods
  public Item GetQueryItemFromDefinition(string queryItemRefId);
}

QueryItemResult Class

Inheritance object → QueryItemResult

Implements IQueryItemResult

public class QueryItemResult : IQueryItemResult
{

  // Properties
  public string ItemId { get; }
  public string QueryAlias { get; }
  public string QueryReferencePath { get; }

  // Methods
  public string GetProperty(string name);
  public string GetPropertyAttribute(string propertyName, string attributeName);
}

ReferenceType Enum

Inheritance object → ValueType → Enum → ReferenceType

public enum ReferenceType
{
  Child = 0,
  Join = 1,
}

RowContextData Class

Inheritance object → RowContextData

public class RowContextData
{
  // Constructors
  public RowContextData();

  // Properties
  public Dictionary<string, TreeRowItemData> Entries { get; }

  // Methods
  public bool Equals(object obj);
  public int GetHashCode();
}

ShowMoreOffsetInfo Class

Inheritance object → ShowMoreOffsetInfo

public class ShowMoreOffsetInfo
{
  // Constructors
  public ShowMoreOffsetInfo();

  // Properties
  public SortedDictionary<string, int> CurrentOffsetByQbPath { get; }
}

TreeCell Class

Inheritance object → TreeCell

public class TreeCell
{
  // Constructors
  public TreeCell();

  // Properties
  public BaseView CellView { get; set; }
  public string DataObject { get; set; }
  public string IconPath { get; set; }
  public bool IsReferencing { get; set; }
  public TreeCellStyle Style { get; set; }
  public string Value { get; set; }
}

TreeCellStyle Class

Inheritance object → TreeCellStyle

public class TreeCellStyle
{
  // Constructors
  public TreeCellStyle();

  // Properties
  public string Justification { get; set; }
}

TreeGridViewDefinition Class

Inheritance object → TreeGridViewDefinition

public class TreeGridViewDefinition
{

  // Properties
  public ICollection<ColumnDefinition> ColumnDefinitions { get; }
  public ICollection<LocalStyle> LocalStyles { get; }
  public string Name { get; }
  public QueryDefinition QueryDefinition { get; }
  public ICollection<TreeRowDefinition> TreeRowDefinitions { get; }
  public ICollection<TreeRowReference> TreeRowReferences { get; }
}

TreeGridViewDefinitionFactory Class

Inheritance object → TreeGridViewDefinitionFactory

public static class TreeGridViewDefinitionFactory
{

  // Methods
  public static TreeGridViewDefinition Create(Item viewDefinitionItem, Dictionary<string, string> parameterValueByName);
}

TreeRow Class

Inheritance object → TreeRow

public class TreeRow
{
  // Constructors
  public TreeRow(TreeRowDefinition rowDefinition, ICollection<TreeRowItem> contextItems);

  // Properties
  public Dictionary<ColumnDefinition, BuilderMethodResult> Cells { get; set; }
  public ICollection<TreeRow> ChildRows { get; }
  public RowContextData ContextData { get; set; }
  public TreeRowDefinition RowDefinition { get; }
}

TreeRowDefinition Class

Inheritance object → TreeRowDefinition

public class TreeRowDefinition
{
  // Constructors
  public TreeRowDefinition(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_TreeRowDefinition"

  // Properties
  public string QueryItemRefId { get; }
  public string RefId { get; }
}

TreeRowItem Class

Inheritance object → TreeRowItem

public class TreeRowItem
{

  // Properties
  public IQueryItemResult QueryItemResult { get; }
  public TreeRowDefinition TreeRowDefinition { get; }
}

TreeRowItemData Class

Inheritance object → TreeRowItemData

public class TreeRowItemData
{
  // Constructors
  public TreeRowItemData(string id, string qbPath);

  // Properties
  public string Id { get; }
  public string QbPath { get; set; }
  [JsonProperty()]
  public string QbPathKey { get; set; }

  // Methods
  public bool Equals(object obj);
  public int GetHashCode();
  public string ToString();
}

TreeRowReference Class

Inheritance object → TreeRowReference

public class TreeRowReference
{
  // Constructors
  public TreeRowReference(Item itemModel);

  // Fields
  public const string ItemTypeName = @"rb_TreeRowReference"

  // Properties
  public string ChildRefId { get; }
  public string ParentRefId { get; }
  public ReferenceType ReferenceType { get; }
  public string SourceId { get; }
  public int ViewOrder { get; }
}