Class ViewPartAttribute
Extension attribute for integrating new view parts into Studio applications.
Inheritance
Namespace: Sdl.Desktop.IntegrationApi.Extensions
Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public sealed class ViewPartAttribute : ExtensionAttribute
Remarks
A view part needs to implement the AbstractViewPartController class.
Constructors
ViewPartAttribute()
Default constructor for XML serialization.
Declaration
public ViewPartAttribute()
ViewPartAttribute(String, String, String, String, Keys)
Initialize the viewpart attribute.
Declaration
public ViewPartAttribute(string id, string name, string description, string helpTopic, Keys shortcut)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The unique id for the viewpart. |
System.String | name | The name for this view. Should typically be a key of a resource string in PluginResources.resx. |
System.String | description | The description for this view. Should typically be a key of a resource string in PluginResources.resx. |
System.String | helpTopic | The help topic identifier of the viewpart. |
System.Windows.Forms.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)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The unique id for the viewpart. |
System.String | helpTopic | The help topic identifier of the viewpart. |
System.Windows.Forms.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 |
---|---|
System.String |
Shortcut
Gets or sets the shortcut for accessing this view.
Declaration
public Keys Shortcut { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Forms.Keys |