Class UtilButtonContextHelper

Helper methods for IUtilButtonContext

Inheritance

object

UtilButtonContextHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class UtilButtonContextHelper

Methods

Description(ComWrapper<IUtilButtonContext>)

Description of utility

Declaration

public static string Description(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

Enabled(ComWrapper<IUtilButtonContext>)

Visibility of utility button

Declaration

public static bool Enabled(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
bool

Hint(ComWrapper<IUtilButtonContext>)

Hint text of utility button

Declaration

public static string Hint(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

HintText(ComWrapper<IUtilButtonContext>)

Text of hint window of utility button

Declaration

public static string HintText(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

HintTitle(ComWrapper<IUtilButtonContext>)

Title of hint window of utility button

Declaration

public static string HintTitle(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

IconId(ComWrapper<IUtilButtonContext>)

Identifier for icon, if utility is internal

Declaration

public static int IconId(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
int

IconPath(ComWrapper<IUtilButtonContext>)

Icon of utility button

Declaration

public static string IconPath(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

LoadInfo(ComWrapper<IUtilButtonContext>)

Additional information about loading utility module

Declaration

public static string LoadInfo(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

LoaderExtensionIdent(ComWrapper<IUtilButtonContext>)

Identifier of extension, which is used to load and execute utility

Declaration

public static string LoaderExtensionIdent(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

ModulePath(ComWrapper<IUtilButtonContext>)

Path to executable file

Declaration

public static string ModulePath(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

Name(ComWrapper<IUtilButtonContext>)

Name of utility

Declaration

public static string Name(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

SetDescription(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetDescription(this ComWrapper<IUtilButtonContext> utilCom, string description)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	description

SetEnabled(ComWrapper<IUtilButtonContext>, bool)

Declaration

public static void SetEnabled(this ComWrapper<IUtilButtonContext> utilCom, bool value)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
bool	value

SetHint(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetHint(this ComWrapper<IUtilButtonContext> utilCom, string hint)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	hint

SetHintText(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetHintText(this ComWrapper<IUtilButtonContext> utilCom, string text)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	text

SetHintTitle(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetHintTitle(this ComWrapper<IUtilButtonContext> utilCom, string title)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	title

SetIconId(ComWrapper<IUtilButtonContext>, int)

Declaration

public static void SetIconId(this ComWrapper<IUtilButtonContext> utilCom, int id)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
int	id

SetIconPath(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetIconPath(this ComWrapper<IUtilButtonContext> utilCom, string path)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	path

SetLoadInfo(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetLoadInfo(this ComWrapper<IUtilButtonContext> utilCom, string info)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	info

SetLoaderExtensionIdent(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetLoaderExtensionIdent(this ComWrapper<IUtilButtonContext> utilCom, string ident)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	ident

SetModulePath(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetModulePath(this ComWrapper<IUtilButtonContext> utilCom, string path)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	path

SetName(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetName(this ComWrapper<IUtilButtonContext> utilCom, string name)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	name

SetUid(ComWrapper<IUtilButtonContext>, string)

Declaration

public static void SetUid(this ComWrapper<IUtilButtonContext> utilCom, string uid)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
string	uid

SetVisibleOnlyInExpertMode(ComWrapper<IUtilButtonContext>, bool)

Declaration

public static void SetVisibleOnlyInExpertMode(this ComWrapper<IUtilButtonContext> utilCom, bool value)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom
bool	value

UiVisible(ComWrapper<IUtilButtonContext>)

Ui visibility of utility

Declaration

public static bool UiVisible(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
bool

Uid(ComWrapper<IUtilButtonContext>)

Unique ident of utility

Declaration

public static string Uid(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
string

VisibleOnlyInExpertMode(ComWrapper<IUtilButtonContext>)

Utility is available only when expert mode in settings is enabled

Declaration

public static bool VisibleOnlyInExpertMode(this ComWrapper<IUtilButtonContext> utilCom)

Parameters

Type	Name	Description
ComWrapper<IUtilButtonContext>	utilCom

Returns

Type	Description
bool