Class RibbonGroupAttribute

Decorate a ribbon group of a Studio application provinding metadata informations

Inheritance

System.Object

AbstractCommandBarItemAttribute

RibbonGroupAttribute

Inherited Members

AbstractCommandBarItemAttribute.ContextByType

Namespace: Sdl.Desktop.IntegrationApi.Extensions

Assembly: Sdl.Desktop.IntegrationApi.Extensions.dll

Syntax

[AttributeUsage(AttributeTargets.Class)]
public class RibbonGroupAttribute : AbstractCommandBarItemAttribute

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

RibbonGroupAttribute(String)

Initialize the instance of the ribbon group attribute

Declaration

public RibbonGroupAttribute(string id)

Parameters

Type	Name	Description
System.String	id	The unique identifier of the ribbon group

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.

RibbonGroupAttribute(String, String)

Initialize the instance of the ribbon group attribute

Declaration

public RibbonGroupAttribute(string id, string name)

Parameters

Type	Name	Description
System.String	id	The unique identifier of the ribbon group
System.String	name	The name that will be displayed by the ribbon group.

RibbonGroupAttribute(String, String, Type)

Initialize the instance of the ribbon group attribute

Declaration

public RibbonGroupAttribute(string id, string name, Type contextByType)

Parameters

Type	Name	Description
System.String	id	The unique identifier of the ribbon group
System.String	name	The name that will be displayed by the ribbon group.
System.Type	contextByType	The context in which the ribbon is working

RibbonGroupAttribute(String, Type)

Initialize the instance of the ribbon group attribute

Declaration

public RibbonGroupAttribute(string id, Type contextByType)

Parameters

Type	Name	Description
System.String	id	The unique identifier of the ribbon group
System.Type	contextByType	The context in which the ribbon group is available and enabled.

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.

Extension Methods

WindowsControlUtils.ForWindowFromFrameworkElement(Object, Action<Window>)