ObjectDCL Banner

Control_ZOrder Method

Description

This method will move the control to the front of all controls or behind all controls.

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.
Direction
Integer specifying the direction on the stack of controls to move the specified control.
  • 0 (Move to the Bottom of the Tab/ZOrder list)
  • 1 (Move to the Top of the Tab/ZOrder list)

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Control_ZOrder 
		MyControlReference [as Reference]
		Direction [as Integer])

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

CopyCode imageCopy Code
(Odcl_Control_ZOrder
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Direction [as Integer])

Applies For

ActiveX, AngleSlider, Animation, BlockList, BlockView, CheckBox, ComboBox, DwgList, DwgPreview, Frame, GraphicButton, EditableGrid, Grid (Hatch), HtmlControl, ImageCombo, Label, ListBox, ListView, MonthPicker, Option, OptionList, PictureBox, ProgressBar, Rectangle, ScrollBar, SliderBar, SlideView, SpinButton, Splitter, TabControl, TextBox, TextButton, TreeControl, UrlLink.

Example

CopyCode imageCopy Code
; Move the control to the bottom
(Odcl_Control_ZOrder MyProject_MyForm_MyControl 0)

See Also

Control_GetCurPos, Control_SetPos, Control_SetFocus, GetFocus