Public functions of KozMos VLDCL System

  Function description for KozMos VLDCL System
　
vldcl-action
(vldcl-action KeyNameString)
Define default action_tile function to certain tile according with the key string.
Argument 1 STRING The string of tile's key.
Return SUCCESS NONE
　 FAILURE NONE
vldcl-checklist
(vldcl-checklist TitleString MessageString DotPairedList)
Convert a toggle data list into two lists, one for source, one for selected and enable users to perform a selection.
See dialog screenshot HERE!
Argument 1 STRING The dialog title string.
NIL for default string of "VLDCL-CHECKLIST"
Argument 2 STRING The prompt message string.
NIL for default string of "Message".
Argument 3 LIST A dot paired list.
Return SUCCESS The returned dot paired list.
　 FAILURE NIL
vldcl-colordlg
(vldcl-colordlg DefaultColorNumber)
Call AutoCAD color or truecolor dialog and return save data format as acad_truecolordlg.
Argument 1 STRING/INT The default color number or number string.
Minus number (string) for truecolor.
Return SUCCESS The dot paired list of color.
((62 . xxx)(420 . zzzzzzz))
　 FAILURE NIL
vldcl-colordlg-excel
(vldcl-colordlg-excel DefaultExcelColorIndexNumber)
Call a color selection dialog to select Excel Color Index. Also the most matched ACI and truecolor will also be shown in the dialog. See detail about the dialog HERE!
Argument 1 INT The default Excel Color Index number, must be an integer between 0 and 57. (not include 0 and 57).
Return SUCCESS Data of the selected Excel Color Index. Syntax as (ECI ACI TrueColor)
　 FAILURE NIL
vldcl-combolist
(vldcl-combolist TitleString MessageString List DefaultString)
Display all contents of a list and enable users to select one.
See dialog screenshot HERE!
Argument 1 STRING The dialog title string.
NIL for default string of "VLDCL-COMBOLIST"
Argument 2 STRING The prompt message string.
NIL for default string of "Message".
Argument 3 LIST A string list.
Argument 4 STRING An item of the list as default value.
Return SUCCESS The selected content from the list.
　 FAILURE Default value.
vldcl-donedialog
(vldcl-donedialog DialogNameString DonedialogID)
Run certain proper function according with the done_dialog ID from dialog.
Argument 1 STRING The dialog name string.
Argument 2 INT The done_dialog ID from dialog.
Return SUCCESS Run certain proper pre-defined function.
　 FAILURE NIL
vldcl-e-digit
(vldcl-e-digit Flag)
Control if treat string such as "1.23e5" as digit (REAL or INT) by calling vldcl-string-type
Please note, if vldcl-e-digit is given T,
    (vldcl-string-type "12e2") will return INT;
    (vldcl-string-type "1.2e2") will return REAL.
Argument 1 T/NIL The flag T for treating E as digit, nil for string.
Return SUCCESS "1"
　 FAILURE ""
vldcl-editbox-arch
(vldcl-editbox-arch Edit_BoxKeyString Edit_BoxValueString ArchitecturalRangeFlag)
Check if the value is valid as a proper architectural in edit_box.
Argument 1 STRING The edit_box key name string.
Argument 2 STRING The value in edit_box or prepare to fill in edit_box.
Argument 3 STRING The range of the architectural to be checked.
Return SUCCESS Fill value in edit_box and update global variable *DCL-DATA*.
　 FAILURE Fill old value saved in *DCL-DATA* in edit_box field.
vldcl-editbox-int
(vldcl-editbox-int Edit_BoxKeyString Edit_BoxValueString IntegerRangeFlag)
Check if the value is valid as a proper integer in edit_box.
Argument 1 STRING The edit_box key name string.
Argument 2 STRING The value in edit_box or prepare to fill in edit_box.
Argument 3 STRING The range of the integer to be checked.
Return SUCCESS Fill value in edit_box and update global variable *DCL-DATA*.
　 FAILURE Fill old value saved in *DCL-DATA* in edit_box field.
vldcl-editbox-list
(vldcl-editbox-int Edit_BoxKeyString Edit_BoxValueString)
Check if the value is valid for being a list in edit_box, items were seperated by spacebar
Argument 1 STRING The edit_box key name string.
Argument 2 STRING The value in edit_box or prepare to fill in edit_box.
Return SUCCESS Fill value in edit_box and update global variable *DCL-DATA*.
　 FAILURE Fill old value saved in *DCL-DATA* in edit_box field.
vldcl-editbox-real
(vldcl-editbox-real Edit_BoxKeyString Edit_BoxValueString RealRangeFlag)
Check if the value is valid as a proper real in edit_box.
Argument 1 STRING The edit_box key name string.
Argument 2 STRING The value in edit_box or prepare to fill in edit_box.
Argument 3 STRING The range of the real to be checked.
Return SUCCESS Fill value in edit_box and update global variable *DCL-DATA*.
　 FAILURE Fill old value saved in *DCL-DATA* in edit_box field.
vldcl-editbox-string
(vldcl-editbox-string Edit_BoxKeyString Edit_BoxValueString)
Fill a string in edit_box.
Argument 1 STRING The edit_box key name string.
Argument 2 STRING The value in edit_box or prepare to fill in edit_box.
Return SUCCESS Fill value in edit_box and update global variable *DCL-DATA*.
　 FAILURE Fill old value saved in *DCL-DATA* in edit_box field.
vldcl-get-value
(vldcl-get-value TileKeyString VLDCLDXFID)
Read *DCL-DATA* and get certain DXF value of certain tile.
See also vldcl-put-value
Argument 1 STRING The tile's key string.
Argument 2 INT The VLDCL DXF code ID.
Return SUCCESS The value saved in *DCL-DATA*.
　 FAILURE NIL
vldcl-getarch
(vldcl-getarch MessageString DefaultArchitecturalNumber)
Display a dialog box to enter an architectural number.
The VLDCL can only analysis typical architectural number string, so you MUST add [0'] or [0/12"] in input in order to pass the string type check, or VLDCL wil refuse the input. For example, we have to enter [0'-12 0/32"] to confirm a simple [12"] in architectural system.
Argument 1 STRING The prompt message on dialog.
Argument 2 STRING The default architectural number string.
Return SUCCESS User input architectural number string.
　 FAILURE The default integer number string.
vldcl-getint
(vldcl-getint MessageString DefaultINTNumber)
Display a dialog box to enter an integer number.
Argument 1 STRING The prompt message on dialog.
Argument 2 STRING/INT The default integer number or number string.
Return SUCCESS User input integer number string.
　 FAILURE The default integer number string.
vldcl-getpassword
(vldcl-getpassword PromptString)
Display a dialog box to enter the secret password. All entered will be displayed as "*".
Argument 1 STRING The prompt message on dialog.
Return SUCCESS User input password string.
　 FAILURE NIL
vldcl-getreal
(vldcl-getreal MessageString DefaultREALNumber)
Display a dialog box to enter an integer number.
Argument 1 STRING The prompt message on dialog.
Argument 2 STRING/INT The default real number or number string.
Return SUCCESS User input real number string.
　 FAILURE The default real number string.
vldcl-getstring
(vldcl-getstring MessageString DefaultString)
Display a dialog box to enter an integer number.
Argument 1 STRING The prompt message on dialog.
Argument 2 STRING The default string.
Return SUCCESS User input string.
　 FAILURE The default string.
vldcl-graytile
(vldcl-graytile TileKeyString TileValueString)
Fill a string in edit_box.
Argument 1 STRING The key name string.
Argument 2 STRING The value of certain tile.
Return SUCCESS If "Gray Tiles List" defined, run it.
　 FAILURE NIL
vldcl-image-combocolor
(vldcl-image-combocolor ImageKeyString)
Establish the link between image_button and the text_part or color number (got from VLDCL DXF4) and provide color selecting via AutoCAD standard color dialog.
Argument 1 STRING The image tile's key name string.
Return SUCCESS Pick the image_button will show AutoCAD color dialog and the text_part (if defined) shows current color number.
　 FAILURE NIL
vldcl-image-fill-color
(vldcl-image-fill-color ImageKeyString ACIColorNumber)
Fill a solid ACI color in image or image_button. Normally support ACI color and true color. Most truecolor index number is more than 256, this function can convert the truecolor into a closest matched ACI color to display in the iamge or image_button.
There are slao some (only few) truecolor index number is smaller than 256, in this situation, please convert the truecolor index number into a minus integer, then this function will treat the number as truecolor number.
Argument 1 STRING The image tile's key name string.
Argument 2 INT The ACI or truecolor index number.
Return SUCCESS Fill certain ACI color in image.
　 FAILURE NIL
vldcl-image-fill-slide
(vldcl-image-fill-slide ImageKeyString SLDorSLBFileString)
Fill a slider in image or image_button.
Argument 1 STRING The image tile's key name string.
Argument 2 INT The SLD file name string or slide in slide Library (same string used in AutoLISP).
Return SUCCESS Display certain slide in image.
　 FAILURE NIL
vldcl-image-fill-text
(vldcl-image-fill-text TextString FillData)
Fill a text string in image or image_button.
Argument 1 STRING The text string to display.
Argument 2 LIST A dot-paired data for control data to fill text.
Syntax is:
(list (cons 10 StartX[INT] StartY[INT])
      (cons 70 JustificationType[STRING])
      (cons 50 RotationAngle[INT])
      (cons 62 ACIColor[INT])
)

JustificationType: "TL" "TM" "TR" "ML" "MC" "MR" "L" "C" "R"
RotationAngle: 0 for 0 degree, other integer for 90 degree
ACIColor: Any valid color 1~255 (do not use 0 and 256)
Return SUCCESS Display certain slide in image.
　 FAILURE NIL
vldcl-init
(vldcl-init DCLFileNameString DialogNameString)
Load a DCL file and display certain defined dialog.
Argument 1 STRING The DCL full path file name.
Argument 2 INT The dialog name defined in DCL file to start.
Return SUCCESS Display the dialog.
　 FAILURE NIL
vldcl-list
(vldcl-list ListKeyString ListValueString)
Processing list tile's operation.
Argument 1 STRING The list tile's key string.
Argument 2 INT The list tile's value integer string to set to list tile.
Return SUCCESS Set list tile and update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-list-value
(vldcl-list-value ListKeyString)
Get the real value list of a certain list tile. Support multiple selected list.
Argument 1 STRING The list tile's key string.
Return SUCCESS A list of the real value reading from VLDCL DXF1 & DXF2.
　 FAILURE NIL
vldcl-module
(vldcl-module DCLFileNameString DialogNameString EnableRegisterShellFlag)
VLDCL main module. Scan *DCL-DATA* to initialize dialog.
Argument 1 STRING The DCL file name (MUST contain ".DCL" suffix)
Argument 2 STRING The start dialog name string.
Argument 3 INT The flag to enable RegisterShell.
1 for enable RegisterShell, other value for disable RegisterShell.
Return SUCCESS Load DCL file, open and initialize dialog.
　 FAILURE NIL
vldcl-msgbox
(vldcl-msgbox IconType TitleString MessageString)
Display an alert contain one icon (? / ! / X) via VBA.
If you want to use more buttons, please referrence to VLDOS function: vldos-msgbox
Argument 1 STRING The icon type, should be one of the following:
  • "vbInformation" or "!"
  • "vbQuestion" or "?"
  • "vbCritical" or "x"
Argument 2 STRING The title string.
Argument 3 INT The message string.
Return SUCCESS Display the alert message box.
　 FAILURE NIL
vldcl-pickdxf
(vldcl-pickdxf PromptString DXFCodeToGet UseNentselToPickNestObject?)
Prompt users to pick an object and get value of certain DXF code.
Use this function will reduce codes on getting object DXF data such as content, layer, type etc and pass the non-null return value into dialog interface.
Argument 1 STRING The prompt message string.
NIL will use default prompt string.
Argument 2 INT The DXF code to get value.
Argument 3 BOOLEAN If use NENTSEL to pick nested object.
Return SUCCESS New properties' dot paired list.
　 FAILURE NIL
vldcl-proplist
(vldcl-proplist MessageString PropertyDotPairedList)
Display a properties list box to edit or add properties.
See dialog screenshot HERE!
Argument 1 STRING The message string.
Argument 2 STRING The properties' dot paired list. Syntax as '((ID1 . VAL1)(ID2 . VAL2)...)
Return SUCCESS New properties' dot paired list.
　 FAILURE NIL
vldcl-progressbar
(vldcl-progressbar DCLKeyListOrString FillACIColor PercentageValue)
Performing a dynamic progress bar in a DCL image/image_button with certain ACI color.
Argument 1 STRING
LIST		 The image/image_button tile's key string or a list contain two tiles' keys (the 1st is the image key, the 2nd is a text key that will used to display the percentage number).
Argument 2 INT The ACI color number filled in, default is 5 for blue.
Argument 3 REAL The current displayed percentage.
The range id between 0 and 100.
Return SUCCESS Fill in image/image_button with certain percentage and color, if the text key is indicated, fill the percentage number to the contain text tile.
　 FAILURE NIL
vldcl-put-value
(vldcl-put-value TileKeyString VLDCLDXFID DXFValue)
Modify certain DXF value of certain tile in *DCL-DATA*.
Put value to VLDCL DXF0 will be ignored.
See also vldcl-get-value

Enhanced features:
Now vldcl-put-value can pass value into *DCL-DATA* without pre-definition. In this means, the programmers can define his own VLDCL ID codes and values and save the data into *DCL-DATA* by calling vldcl-put-value.
If the Third argument is set to NIL, vldcl-put-value will automatically remove the certain VLDCL data in the ID field.

Examples:
(vldcl-put-value "DCLTileKey" 10 '("cc" "bb" "aa"))
>> (......."DCLTileKey" (1 . "list")(2 . ("ff"))(10 . ("cc" "bb" "aa"))....)
(vldcl-put-value "DCLTilerKey" 10 nil)
>> (......."DCLTileKey" (1 . "list")(2 . ("ff")))....)
Argument 1 STRING The tile's key string.
Argument 2 INT / ANY The VLDCL DXF code ID.
Argument 3 ANY The new VLDCL DXF code value.
Return SUCCESS Update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-regmessage
(vldcl-regmessage)
Get a string contain the registration information which contains the registered username and registration cede. If RegisterShell is NOT defined, return null string.
Return SUCCESS The returned string will follow the syntax below:
  • Registration Information:
    [UserNameTXT DXF1] xxxx
    [RegCodeTXT DXF1] xxxx xxxx
　 FAILURE ""
vldcl-radio
(vldcl-radio MainRadioKeyString RadioButtonKeySring)
Processing radio_button tile's operation.
Argument 1 STRING The parent radio column(row) tile's key string.
Argument 2 STRING The radio_button's key string.
Return SUCCESS NONE
　 FAILURE NIL
vldcl-radioaction
(vldcl-radioaction MainRadioKeyString RadioButtonKeySring)
Check and run "c:vldcl-radioaction-*" for main radio key and "c:vldcl-action-*" for all radio_button keys. The function of main radio key will contain one argument of the current radio_button key string.
Argument 1 STRING The parent radio column(row) tile's key string.
Argument 2 STRING The radio_button's key string.
Return SUCCESS NONE
　 FAILURE NIL
vldcl-set-tabs
(vldcl-set-tabs TabsString)
Set the tabs data into VLDCL clipboard so that VLDCL LIST tile can use.
Argument 1 STRING The tabs string for DCL list tile.
Return SUCCESS Tabs string itself.
　 FAILURE NIL
vldcl-settile
(vldcl-settile)
Scan *DCL-DATA* and initialize dialog tiles.
Return SUCCESS NONE
　 FAILURE NIL
vldcl-slider
(vldcl-slider SliderKeyString SliderValueString)
Processing slider tile's operation.
Argument 1 STRING The slider tile's key string.
Argument 2 STRING The slider tile's value or interger string to set to slider tile. VLDCL will check this value, if it is out of range, VLDCL will use the minimium value from VLDCL DXF2.
Return SUCCESS Set slider tile and update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-string-type
(vldcl-string-type GivenString)
Check the given string type, result will be one of the four: "STRING"; "REAL"; "INT"; "ARCH".
Letter e in "1.23e5" will return "REAL" or "STRING", to control the return value, see vldcl-e-digit
Argument 1 STRING The given string.
Return SUCCESS One of the four: "STRING"; "REAL"; "INT"; "ARCH".
　 FAILURE NIL
vldcl-string2list
(vldcl-string2list SourceStringOrList TokenString)
Split a string by token string or join a string list using the token string.
Argument 1 STRING/LIST The given string or string list.
Argument 2 STRING The token string.
Return SUCCESS If input is string, return will be list;
If input is list, return will be string.
　 FAILURE NIL
vldcl-subdialog
(vldcl-subdialog TileKeyString SubDialogNameString)
Open a sub-dialog by action to certain tile in parent dialog.
Argument 1 STRING The tile's key string.
Argument 2 STRING The opened sub-dialog name string.
Return SUCCESS Open & initialize sub-dialog and update *DIALOG*.
　 FAILURE NIL
vldcl-text
(vldcl-text TextKeyString TextValueString)
Processing text tile's operation.
Argument 1 STRING The text tile's key string.
Argument 2 STRING The string to set to text tile.
Return SUCCESS Set text tile and update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-toggle
(vldcl-toggle ToggleKeyString ToggleValueString)
Processing toggle tile's operation.
Argument 1 STRING The toggle tile's key string.
Argument 2 STRING The toggle tile's value string to set to toggle tile.
Only can be "0" or "1".
Return SUCCESS Set toggle tile and update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-vbutton
(vldcl-vbutton VButtonKeyString ButtonLabelString ButtonLabelColorACI)
Processing vbutton tile's operation.
Argument 1 STRING The label string, if it is NIL, function will use "VirtualButton" as default.
Argument 2 INT The label color. support both ACI and AutoCAD2004+ true color.
Return SUCCESS Correct vbutton tile performance and update global variable *DCL-DATA*.
　 FAILURE NIL
vldcl-viewlist
(vldcl-viewlist TitleString MessageString ListData)
Display a string list in a single list dialog, used to view data.
See dialog screenshot HERE!
Argument 1 STRING The title string.
Argument 2 STRING The prompt message string.
Argument 3 STRING The string list to display.
Return SUCCESS Pick OK button will return selected content string;
Pick Cancel button will return 0.
　 FAILURE NIL
vldcl-viewslide
(vldcl-viewslide SlideFilenameString MessageString)
Display the AutoCAD slide file, enable dynamic display of PAN and ZOOM (Window and Scale).
See dialog screenshot HERE!
This function always return T.
Argument 1 STRING The Slide file name string with full path.
Argument 2 STRING A string showed in the middle of bottom of the image_buttom.
If it is nil, a default KozMos VLDCL System message will be displayed
Return SUCCESS T
　 FAILURE T
vldcl-yesno
(vldcl-yesno PromptStringOrStringList)
Display the prompt strings (similar as alert function), but provide two buttons to select. Different button will return different value.
Argument 1 STRING/LIST The displayed strings or strings' list.
Return SUCCESS Pick OK button will return 1;
Pick Cancel button will return 0
　 FAILURE NIL
　

//Koz Jono Yeoh//

Copyright(C) 1994-2009 KozMos Inc
All rights reserved.