Show / Hide Table of Contents

    Class Identity

    Methods for discovering and tracking stable identifiers for Elements.

    Inheritance
    System.Object
    Identity
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Elements
    Assembly: Hypar.Elements.dll
    Syntax
    public static class Identity

    Methods

    AddOverrideIdentity(Element, IOverride)

    Track that an element was affected by a specific override.

    Declaration
    public static void AddOverrideIdentity(this Element element, IOverride overrideObject)
    Parameters
    Type Name Description
    Element element
    IOverride overrideObject

    AddOverrideIdentity(Element, String, String, Object)

    Track that an element was affected by a specific override.

    Declaration
    public static void AddOverrideIdentity(this Element element, string overrideName, string overrideId, object overrideIdentity)
    Parameters
    Type Name Description
    Element element

    The element that was overridden.

    System.String overrideName

    The name of the override property, from the hypar.json.

    System.String overrideId

    The unique ID of the specific override within overrideName that is associated with this element.

    System.Object overrideIdentity

    The identity object that the override used to describe the object.

    AddOverrideValue(Element, String, Object)

    Add the final values used from an override to an element or proxy. This is only required if the override schema does not reflect the element schema, or if the properties within the override were not added directly to additionalProperties. In the earlier two cases, the data on the element within the schema or in additionalProperties will be used as the current values for override.

    Declaration
    public static void AddOverrideValue(this Element element, string overrideName, object overrideValue)
    Parameters
    Type Name Description
    Element element
    System.String overrideName
    System.Object overrideValue

    OverrideIds<T>(Element, String)

    Get the IDs of all overrides of this type that were already attached using AddOverrideIdentity to this element.

    Declaration
    public static List<string> OverrideIds<T>(this Element element, string overrideName)
    Parameters
    Type Name Description
    Element element
    System.String overrideName
    Returns
    Type Description
    System.Collections.Generic.List<System.String>
    Type Parameters
    Name Description
    T