Mark > Mark Dialog

<< Click to Display Table of Contents >

Client Control Interface Manual > Mark > Mark Dialog

Mark Dialog

Previous page

Return to chapter overview

Next page

•Mark Dialog Status

•Open / Close Mark Dialog

•Mark Dialog Repeat Mark

•Mark Dialog Selected Status

Mark Dialog Status		☐ Set ☒ Get
DLL Function	int State = ScGetLongValue (int Value_Type)
ASCII Function	int State = ScCciGetLongValue(int Value_Type)
Description	Return the state of the mark dialog. •0: Mark dialog is closed. •1: Mark dialog is open.
Value_Type	Type: int	ID:
	Location: ScComSAMLightClientCtrlValueTypes
	scComSAMLightClientCtrlLongValueTypeIsMarkDialogOpen	135
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Get the state of the mark dialog: int State = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeIsMarkDialogOpen );

Table 280: Mark Dialog Status

Open / Close Mark Dialog		☒ Set ☐ Get
DLL Function	int CCI_Return = ScExecCommand(int Cmd_ID)
ASCII Function	int CCI_Return = ScCciExecCommand(int Cmd_ID)
Description	Open or close the mark dialog.
Cmd_ID	Type: int	ID:
	Location: ScComSAMLightClientCtrlExecCommandConstants
	scComSAMLightClientCtrlExecCommandOpenMarkDialog	48
	Open the Mark dialog.
	scComSAMLightClientCtrlExecCommandCloseMarkDialog	49
	Close the Mark dialog.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•The state of the mark dialog can be obtained as well.
C# Example: Open the mark dialog: int CCI_Return = cci.ScExecCommand( ( int )ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandOpenMarkDialog );

Table 281: Open / Close Mark Dialog

Mark Dialog Repeat Mark			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetLongValue(int Value_Type, int Enable_Button_Repeat) int Enable_Button_Repeat = ScGetLongValue(int Value_Type)
ASCII Function	int CCI_Return = ScCciSetLongValue(int Value_Type, int Enable_Button_Repeat) int Enable_Button_Repeat = ScCciGetLongValue(int Value_Type)
Description	Set or get the status of the 'Repeat Mark' Checkbox of the Mark Dialog.
Value_Type	Type: int		ID:
	Location: ScComSAMLightClientCtrlValueTypes
	scComSAMLightClientCtrlLongValueTypeEnableButtonRepeat		170
Checkbox	Type: int	Unit: none
Checkbox	•0: Disable Checkbox •1: Enable Checkbox
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Enable Checkbox for 'Repeat Mark' in the Mark Dialog: int CCI_Return = cci.ScSetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnableButtonRepeat, 1);
C# Example: Get the current status of the Checkbox for 'Repeat Mark' in the Mark Dialog: int Enable_Button_Repeat = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnableButtonRepeat);

Table 282: Mark Dialog Repeat Mark

Mark Dialog Selected Status		☐ Set ☒ Get
DLL Function	int State = ScGetLongValue (int Value_Type)
ASCII Function	int State = ScCciGetLongValue(int Value_Type)
Description	Return the state of the mark dialog Selected option. •0: Mark dialog is closed. •1: Mark dialog is open.
Value_Type	Type: int	ID:
	Location: ScComSAMLightClientCtrlValueTypes
	scComSAMLightClientCtrlLongValueTypeGetMarkDlgSelectedState	164
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Get the state of the mark dialog Selected: int isSelected = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeGetMarkDlgSelectedState ); MessageBox.Show( isSelected.ToString() );

Table 283: Mark Dialog Selected Status