Request

Response

    IElement interface

    This interface is used to define an element.

    public interface IElement
    

    Members

    namedescription
    Attributes { get; } Gets a read-only dictionary of attributes associated with this element. These are system-level attributes that are not displayed in Forma viewer or PowerBI by default.
    Category { get; } Gets the category of the element.
    Classifications { get; } Gets the leaf classification node(s) attached to this element. Walk up via Parent to reconstruct the hierarchy (D-18). Empty if unclassified.
    Design { get; } Gets the design (shared geometry + model hierarchy) this element carries.
    DisplayLengthUnit { get; set; } Gets or Sets the DisplayLengthUnit of the elements.
    Family { get; } Gets the family of the element.
    HasGeometry { get; } Gets a value indicating whether geometry is present inside of the element.
    InstanceParameters { get; } Gets the instance parameters of the element.
    LengthUnit { get; set; } Gets or Sets the LengthUnit of the element.
    Name { get; set; } Gets or Sets the name of the element.
    RenderStyle { get; } Gets the render style attached directly to the Element, if any. Returns null when the Element has no instance level render-style override. See also RenderStyle for the geometry-level render style.
    SourceId { get; set; } Gets or sets the element's source identifier — the Id of the corresponding object in the authoring connector/application. This is the value stored on the underlying element and the key used by GetElementsBySourceId.
    Transformation { get; set; } Gets or Sets the Transformation that represents the current transformation of the element.
    Type { get; } Gets the type referenced by this element (the Type=true design asset), or null if untyped (D-18).
    TypeParameters { get; } Gets the type parameters of the element.
    UniqueId { get; } Gets the system-generated unique persistent Id for this element.
    AddAttributes(…) Adds multiple attributes to this element. These attributes are stored at the instance asset level and are not visible in Forma/PowerBI. They are available through the DX API for connector business logic. Note: If an attribute with the same name already exists on this element, its value is overwritten with the supplied value.
    CreateInstanceParameterAsync(…) This method is used to create an instance parameter.
    CreateInstanceParametersAsync(…) Creates multiple instance parameters for this element.
    CreateReferenceParameter(…) This method is used to create a reference parameter.
    DeleteInstanceParameter(…) This method is used to delete an instance parameter.
    DeleteInstanceParameters(…) Deletes multiple instance parameters from this element.
    FindInstanceParameter(…) Given parameterName, this method returns a matching instance parameter if it is already present in the element, null otherwise.
    GetAttribute(…) Gets the value of a specific attribute by name.
    GetChildElements() This method is used to get child elements.
    UpdateInstanceParameter(…) This method is used to update an instance parameter.
    UpdateInstanceParameters(…) Updates multiple instance parameters for this element.

    See Also