C# Class NDVICustomFunctionUI.NDVICustomFunctionUIClass

Inheritance: IComPropertyPage

Show file Open project: Esri/arcobjects-sdk-community-samples

Public Methods

Method	Description
Activate ( ) : int	Activate the form.
Applies ( ESRI objects ) : bool	Check if the form is applicable to the given set of objects. In this case only the Raster Function object is used to check compatibility.
Apply ( ) : void	Apply the properties set in the form to the arguments object.
Cancel ( ) : void	Do not set any properties set in the form
Deactivate ( ) : void	Shut down the form and destroy the object.
Hide ( ) : void	Hide the form.
NDVICustomFunctionUIClass ( ) : System
SetObjects ( ESRI objects ) : void	Set the necessary objects required for the form. In this case the form is given an arguments object in edit mode, or is required to create one in create mode. After getting or creating the arguments object, template mode is checked for and handled. The template mode requires all parameters of the arguments object to converted to variables.
Show ( ) : void	Show the form.
get_HelpContextID ( int controlID ) : int	Return the help context ID of the form if it exists.

Private Methods

Method	Description
Reg ( string regKey ) : void
Unreg ( string regKey ) : void

Method Details

Activate() public method

Activate the form.

public Activate ( ) : int
return	int

Applies() public method

Check if the form is applicable to the given set of objects. In this case only the Raster Function object is used to check compatibility.

public Applies ( ESRI objects ) : bool
objects	ESRI	Set of object to check against.
return	bool

Apply() public method

Apply the properties set in the form to the arguments object.

public Apply ( ) : void
return	void

Cancel() public method

Do not set any properties set in the form

public Cancel ( ) : void
return	void

Deactivate() public method

Shut down the form and destroy the object.

public Deactivate ( ) : void
return	void

Hide() public method

Hide the form.

public Hide ( ) : void
return	void

NDVICustomFunctionUIClass() public method

public NDVICustomFunctionUIClass ( ) : System
return	System

SetObjects() public method

Set the necessary objects required for the form. In this case the form is given an arguments object in edit mode, or is required to create one in create mode. After getting or creating the arguments object, template mode is checked for and handled. The template mode requires all parameters of the arguments object to converted to variables.

public SetObjects ( ESRI objects ) : void
objects	ESRI	Set of objects required for the form.
return	void

Show() public method

Show the form.

public Show ( ) : void
return	void

get_HelpContextID() public method

Return the help context ID of the form if it exists.

public get_HelpContextID ( int controlID ) : int
controlID	int	Control ID for the sheet.
return	int