Skip to main content

​
Class CommandInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for CommandInfo. An instance of this class describes a custom command, declared and implemented by a document plugin

​
Inheritance

object ← CommandInfo

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
CommandInfo()

Default constructor - defaults any enum props to 0.

​
Properties

​
DisplayName

Display name, shown in menus, command lists and similar GUI elements.

​
Property Value

string

​
DisplayTooltip

Tooltip string associate with the command - can be a literal or a tooltip hint.

​
Property Value

string

​
IconHint

Icon hint, which should resolve to an icon that is compatible in size with a standard menu or dropdown list font. May be blank.

​
Property Value

string

​
Name

The programmatic name of the command, uniquely identifying this command for the document plugin.

​
Property Value

string

​
ReturnType

Declaration of what kind of return type the execution of this command will give. NULL if unknown enum value.

​
Property Value

ReturnType?

​
See Also

CommandInfo.ReturnType_String

​
ReturnType_String

Declaration of what kind of return type the execution of this command will give. Raw string enum value.

​
Property Value

string

​
See Also

CommandInfo.ReturnType

​
See Also

DocumentAgent

Related topics

SuperOffice.WebApi.Agents.DocumentAgentSuperOffice.WebApi.Agents.IDocumentAgentSuperOffice.WebApi.Data.CommandResultSuperOffice.WebApi.Data.CommandActionSuperOffice.WebApi.Data.CustomCommandSuperOffice.WebApi.Data.CommandActionResult