Search Results for

    Show / Hide Table of Contents

    Class ActionAttribute

    Decorate an action of a Studio application provinding metadata informations

    Inheritance
    object
    Attribute
    ExtensionAttribute
    AbstractCommandBarItemAttribute
    ActionAttribute
    BindActionAttribute
    Implements
    _Attribute
    Inherited Members
    AbstractCommandBarItemAttribute.ContextByType
    ExtensionAttribute.Validate(IExtensionAttributeInfo, IExtensionValidationContext)
    ExtensionAttribute.ValidateId(IExtensionAttributeInfo, IExtensionValidationContext)
    ExtensionAttribute.ValidateName(IExtensionAttributeInfo, IExtensionValidationContext)
    ExtensionAttribute.Id
    ExtensionAttribute.Name
    ExtensionAttribute.Description
    ExtensionAttribute.Icon
    Attribute.GetCustomAttributes(MemberInfo, Type)
    Attribute.GetCustomAttributes(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(MemberInfo)
    Attribute.GetCustomAttributes(MemberInfo, bool)
    Attribute.IsDefined(MemberInfo, Type)
    Attribute.IsDefined(MemberInfo, Type, bool)
    Attribute.GetCustomAttribute(MemberInfo, Type)
    Attribute.GetCustomAttribute(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo)
    Attribute.GetCustomAttributes(ParameterInfo, Type)
    Attribute.GetCustomAttributes(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo, bool)
    Attribute.IsDefined(ParameterInfo, Type)
    Attribute.IsDefined(ParameterInfo, Type, bool)
    Attribute.GetCustomAttribute(ParameterInfo, Type)
    Attribute.GetCustomAttribute(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(Module, Type)
    Attribute.GetCustomAttributes(Module)
    Attribute.GetCustomAttributes(Module, bool)
    Attribute.GetCustomAttributes(Module, Type, bool)
    Attribute.IsDefined(Module, Type)
    Attribute.IsDefined(Module, Type, bool)
    Attribute.GetCustomAttribute(Module, Type)
    Attribute.GetCustomAttribute(Module, Type, bool)
    Attribute.GetCustomAttributes(Assembly, Type)
    Attribute.GetCustomAttributes(Assembly, Type, bool)
    Attribute.GetCustomAttributes(Assembly)
    Attribute.GetCustomAttributes(Assembly, bool)
    Attribute.IsDefined(Assembly, Type)
    Attribute.IsDefined(Assembly, Type, bool)
    Attribute.GetCustomAttribute(Assembly, Type)
    Attribute.GetCustomAttribute(Assembly, Type, bool)
    Attribute.Equals(object)
    Attribute.GetHashCode()
    Attribute.Match(object)
    Attribute.IsDefaultAttribute()
    Attribute.TypeId
    object.ToString()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.Desktop.IntegrationApi.Extensions
    Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
    Syntax
    [ExtensionPointInfo("Actions", ExtensionPointBehavior.Static)]
    [AttributeUsage(AttributeTargets.Class)]
    public class ActionAttribute : AbstractCommandBarItemAttribute, _Attribute
    Remarks

    The framework also provides support for getting property values from the PluginResources.resx resource file, which is deployed together with the plug-in manifest. To specify that the value of a certain string property needs to be retrieved from the resource file, annotate the property definition with the PluginResourceAttribute attribute. Users should now specify the name of the resource key, instead of the actual value, as the property value. When no resource string with the specified key can be found, the framework keeps the specified string as the property value. To define non-string properties whose value is stored in the PluginResources.resx resource file, create a string property, which value should be set to a resource key. When consuming the extension, use GetPluginResource<T>(string) tio retriece the resource from the plug-in resource file.

    Constructors

    ActionAttribute(string)

    Initialize the instance of the action attribute

    Declaration
    public ActionAttribute(string id)
    Parameters
    Type Name Description
    string id

    The unique identifier of the action

    Remarks

    This constructor should be used only if pluginresources are used to resolve the name and description of the extension.

    The resource keys for name and description are built from id and postfixed with _Name and _Description.

    ActionAttribute(string, string, string)

    Initialize the instance of the action attribute.

    Declaration
    public ActionAttribute(string id, string name, string description)
    Parameters
    Type Name Description
    string id

    The unique identifier of the action.

    string name

    The name that will be displayed.

    string description

    The description of the action.

    ActionAttribute(string, string, string, Type)

    Initialize the instance of the action attribute.

    Declaration
    public ActionAttribute(string id, string name, string description, Type contextByType)
    Parameters
    Type Name Description
    string id

    The unique identifier of the action.

    string name

    The name that will be displayed.

    string description

    The description of the action.

    Type contextByType

    The context in which the action should work.

    ActionAttribute(string, Type)

    Initialize the instance of the action attribute

    Declaration
    public ActionAttribute(string id, Type contextByType)
    Parameters
    Type Name Description
    string id

    The unique identifier of the action

    Type contextByType

    The context in which the action should work.

    Remarks

    This constructor should be used only if pluginresources are used to resolve the name and description of the extension.

    The resource keys for name and description are built from id and postfixed with _Name and _Description.

    Implements

    _Attribute

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(object, Action<Window>)
    In this article
    • Constructors
      • ActionAttribute(string)
      • ActionAttribute(string, string, string)
      • ActionAttribute(string, string, string, Type)
      • ActionAttribute(string, Type)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX