Search Results for

    Show / Hide Table of Contents

    Class ViewPartAttribute

    Extension attribute for integrating new view parts into Studio applications.

    Inheritance
    object
    Attribute
    ExtensionAttribute
    ViewPartAttribute
    Implements
    _Attribute
    Inherited Members
    ExtensionAttribute.Validate(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()
    Namespace: Sdl.Desktop.IntegrationApi.Extensions
    Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
    Syntax
    [ExtensionPointInfo("IntegrationApi - View Parts", ExtensionPointBehavior.Static)]
    [AttributeUsage(AttributeTargets.Class)]
    public sealed class ViewPartAttribute : ExtensionAttribute, _Attribute
    Remarks

    A view part needs to implement the AbstractViewPartController class.

    Constructors

    ViewPartAttribute(string, string, string, string, Keys)

    Initialize the viewpart attribute.

    Declaration
    public ViewPartAttribute(string id, string name, string description, string helpTopic, Keys shortcut = Keys.None)
    Parameters
    Type Name Description
    string id

    The unique id for the viewpart.

    string name

    The name for this view. Should typically be a key of a resource string in PluginResources.resx.

    string description

    The description for this view. Should typically be a key of a resource string in PluginResources.resx.

    string helpTopic

    The help topic identifier of the viewpart.

    Keys shortcut

    The shortcut key for accessing the viewpart.

    ViewPartAttribute(string, string, Keys)

    Initialize the viewpart attribute.

    Declaration
    public ViewPartAttribute(string id, string helpTopic, Keys shortcut = Keys.None)
    Parameters
    Type Name Description
    string id

    The unique id for the viewpart.

    string helpTopic

    The help topic identifier of the viewpart.

    Keys shortcut

    The shortcut key for accessing the viewpart.

    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.

    Properties

    HelpTopic

    Gets or sets the help topic ID for this view. Can be null.

    Declaration
    public string HelpTopic { get; set; }
    Property Value
    Type Description
    string

    Shortcut

    Gets or sets the shortcut for accessing this view.

    Declaration
    public Keys Shortcut { get; set; }
    Property Value
    Type Description
    Keys

    Implements

    _Attribute

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(object, Action<Window>)
    In this article
    • Constructors
      • ViewPartAttribute(string, string, string, string, Keys)
      • ViewPartAttribute(string, string, Keys)
    • Properties
      • HelpTopic
      • Shortcut
    • Implements
    • Extension Methods
    Back to top Generated by DocFX