ObjectDCL Banner

TextBox_GetFilter Method

Description

This method returns the filter string used by a TextBox control to filter the text entered by the user.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.

Return Values

Returns the following according to the situation:

  • String describing the filter in use.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_TextBox_GetFilter 
		MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_TextBox_GetFilter
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

TextBox.

Example

CopyCode imageCopy Code
; Get the filter
(Setq rValue (Odcl_TextBox_GetFilter MyProject_MyForm_MyControl))

See Also

TextBox_SetFilter