Class ToolDisplayInformationAttribute

Defines the resources to get the information about the IGuiTool to be displayed in the UI.

Inheritance
object
Attribute
ToolDisplayInformationAttribute
Inherited Members
Namespace: DevToys.Api
Assembly: DevToys.Api.dll
Syntax
[MetadataAttribute]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class ToolDisplayInformationAttribute : Attribute

Properties

AccessibleNameResourceName

(optional) Gets or sets the name of the tool that will be told to the user when using screen reader.

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

DescriptionResourceName

Gets or sets the description of the tool.

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

GroupName

Indicates the group in which the tool should appear. The name should corresponds to an existing InternalComponentName value from an exported GuiToolGroup.

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

IconFontName

Gets or sets the name of the font to use to display the IconGlyph.

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

IconGlyph

Gets or sets a glyph for the icon of the tool.

Declaration
public char IconGlyph { get; set; }
Property Value
Type Description
char

LongDisplayTitleResourceName

Gets or sets the long title of the tool that will be displayed in the search bar or at the top of the current tool. Sometimes it is needed to have a different one than the name showed in the menu to increase result accuracy. For example, while ShortDisplayTitleResourceName could be "JSON" for a tool that is under the Formatter category, LongDisplayTitleResourceName could be "JSON Formatter", which can be helpful to differentiate from other similar tools like "JSON Converter".

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

ResourceManagerAssemblyIdentifier

Gets or sets the name of the IResourceAssemblyIdentifier that contains the type indicated by ResourceManagerBaseName.

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

ResourceManagerBaseName

Gets or sets the name of the resource manager's base name to use when looking for resource string for ShortDisplayTitleResourceName, LongDisplayTitleResourceName, DescriptionResourceName, AccessibleNameResourceName and SearchKeywordsResourceName.

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

SearchKeywordsResourceName

(optional) Gets or sets the keywords of the tool that are searched in the localized environment.

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

ShortDisplayTitleResourceName

Gets or sets the short title of the tool in the main menu of the app, for example "JSON".

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

Extension Methods