Artemis logo
Search Results for

    Show / Hide Table of Contents

    Class LayerPropertyGroup

    Represents a property group on a layer

    Note: You cannot initialize property groups yourself. If properly placed and annotated, the Artemis core will initialize these for you.

    Inheritance
    System.Object
    LayerPropertyGroup
    LayerGeneralProperties
    LayerTransformProperties
    Implements
    System.IDisposable
    Namespace: Artemis.Core
    Assembly: Artemis.Core.dll
    Syntax
    public abstract class LayerPropertyGroup : IDisposable

    Constructors

    | Improve this Doc View Source

    LayerPropertyGroup()

    A base constructor for a LayerPropertyGroup

    Declaration
    protected LayerPropertyGroup()

    Properties

    | Improve this Doc View Source

    Feature

    Gets the plugin feature this group is associated with

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

    GroupDescription

    Gets the description of this group

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

    IsHidden

    Gets or sets whether the property is hidden in the UI

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

    LayerBrush

    The layer brush this property group belongs to

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

    LayerEffect

    The layer effect this property group belongs to

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

    LayerProperties

    A list of all layer properties in this group

    Declaration
    public ReadOnlyCollection<ILayerProperty> LayerProperties { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<ILayerProperty>
    | Improve this Doc View Source

    LayerPropertyGroups

    A list of al child groups in this group

    Declaration
    public ReadOnlyCollection<LayerPropertyGroup> LayerPropertyGroups { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ReadOnlyCollection<LayerPropertyGroup>
    | Improve this Doc View Source

    Parent

    The parent group of this group

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

    Path

    The path of this property group

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

    ProfileElement

    Gets the profile element (such as layer or folder) this group is associated with

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

    PropertiesInitialized

    Gets whether this property groups properties are all initialized

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

    Methods

    | Improve this Doc View Source

    DisableProperties()

    Called when the property group is deactivated (either the profile unloaded or the related brush/effect was removed)

    Declaration
    protected abstract void DisableProperties()
    | Improve this Doc View Source

    Dispose()

    Declaration
    public void Dispose()
    | Improve this Doc View Source

    Dispose(Boolean)

    Releases the unmanaged resources used by the object and optionally releases the managed resources.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    | Improve this Doc View Source

    EnableProperties()

    Called when the property group is activated

    Declaration
    protected abstract void EnableProperties()
    | Improve this Doc View Source

    GetAllLayerProperties()

    Recursively gets all layer properties on this group and any subgroups

    Declaration
    public IReadOnlyCollection<ILayerProperty> GetAllLayerProperties()
    Returns
    Type Description
    System.Collections.Generic.IReadOnlyCollection<ILayerProperty>
    | Improve this Doc View Source

    OnPropertyGroupInitialized()

    Called when the property group and all its layer properties have been initialized

    Declaration
    protected virtual void OnPropertyGroupInitialized()
    | Improve this Doc View Source

    PopulateDefaults()

    Called before property group is activated to allow you to populate DefaultValue on the properties you want

    Declaration
    protected abstract void PopulateDefaults()
    | Improve this Doc View Source

    ResetAllLayerProperties()

    Applies the default value to all layer properties

    Declaration
    public void ResetAllLayerProperties()

    Events

    | Improve this Doc View Source

    LayerPropertyOnCurrentValueSet

    Occurs when one of the current value of one of the layer properties in this group changes by some form of input

    Note: Will not trigger on properties in child groups

    Declaration
    public event EventHandler<LayerPropertyEventArgs> LayerPropertyOnCurrentValueSet
    Event Type
    Type Description
    System.EventHandler<LayerPropertyEventArgs>
    | Improve this Doc View Source

    PropertyGroupInitialized

    Occurs when the property group has initialized all its children

    Declaration
    public event EventHandler PropertyGroupInitialized
    Event Type
    Type Description
    System.EventHandler
    | Improve this Doc View Source

    VisibilityChanged

    Occurs when the IsHidden value of the layer property was updated

    Declaration
    public event EventHandler VisibilityChanged
    Event Type
    Type Description
    System.EventHandler

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX