AfrInterfaces Interface CATIAfrCommandHeader

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIAfrCommandHeader

Method Index

o GetCurrentArgument(): Retrieves the argument of the header.
o SetAvailability(CATAfrAvailabilityType,CATFrmState): Manages the availability of the command.
o SetVisibility(int): Sets the header visibility in the Tools/Customize command.

Methods

o GetCurrentArgument

public virtual GetCurrentArgument(

)

Retrieves the argument of the header.

o SetAvailability

public virtual SetAvailability(		`iType`,
		`iState`)

Manages the availability of the command.
Role: This method enables you to make the command of the header available or unavailable.

Parameters:

iType: Command Header availability type.

See also:

iState

Command Header state.
Legal values:

CATFrmAvailable

CATFrmUnavailable

o SetVisibility

public virtual SetVisibility( iIsVisible)

Sets the header visibility in the Tools/Customize command.
Role: This method enables you to hide or show the command header instance in the Tools/Customize command. It can be interesting to hide some command header instances, when you do not want that the end user drag and drop your command in a toolbar.

Parameters:

iIsVisible: The header visibility in the Tools/Customize command.
Legal values: 1 : visible 0 : invisible

This object is included in the file: CATIAfrCommandHeader.h
If needed, your Imakefile.mk should include the module: CATAfrItf