| AddLBImage | Dialogs - Modern - Browser VectorWorks11.0 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION AddLBImage
( dialogID :LONGINT; componentID :LONGINT; resourceType :INTEGER; resourceID :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.AddLBImage(dialogID, componentID, resourceType, resourceID): Special Notes:
AddLBImage is obsolete as of Vectorworks 2012
Description:
Adds specified image resource to image list.
Currently only one resource type is supported: the 'ics8' resource. This is a 16x16 color icon. Pass a value of 1 for the resourceType argument to indicate this type. Call SetVSResourceFile to specify a resource file that contains the icons.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control resourceType type of image resource to be added resourceID the resource ID of image to add See Also:
SetVSResourceFile CreateLB InsertLBColumn SetLBControlType SetLBItemDisplayType InsertLBColumnDataItem SetLBItemUsingColumnDataItem InsertLBItem EnableLBColumnLines
| AddLBOriginalName | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE AddLBOriginalName
( dialogID :LONGINT; componentID :LONGINT; originalName :STRING ) ; Python:
return None
def vs.AddLBOriginalName(dialogID, componentID, originalName): Description:
This function is called when hierarchical display is on and a new item is added to the list browser.Parameters:
dialogID The id of the dialog. componentID The id of the list browser. originalName The original name of the new item being added to the list browser.
| AreLBColumnLinesEnabled | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION AreLBColumnLinesEnabled
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.AreLBColumnLinesEnabled(dialogID, componentID): Description:
Determines if column lines are drawn.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| AreLBRadioColumnLinesEnabled | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION AreLBRadioColumnLinesEnabled
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.AreLBRadioColumnLinesEnabled(dialogID, componentID, columnIndex): Description:
Determines if "column" lines are drawn between radio control items.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| CollapseAllLBItems | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE CollapseAllLBItems
( dialogID :LONGINT; componentID :LONGINT ) ; Python:
return None
def vs.CollapseAllLBItems(dialogID, componentID): Description:
This function is called when a list browser is in hierarchical display mode, and it removes all items that are not at the top level and closes all container items.Parameters:
dialogID The id of the dialog. componentID The id of the list browser.
| CreateLB | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE CreateLB
( dialogID :LONGINT; componentID :LONGINT; widthInCharacters :INTEGER; heightInCharacters :INTEGER ) ; Python:
return None
def vs.CreateLB(dialogID, componentID, widthInCharacters, heightInCharacters): Description:
Creates a layout manager list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control widthInCharacters the width of the control in characters heightInCharacters the height of the control in characters
| DeleteAllLBItems | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION DeleteAllLBItems
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteAllLBItems(dialogID, componentID): Description:
Deletes all list browser items.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| DeleteLBColumn | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION DeleteLBColumn
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteLBColumn(dialogID, componentID, columnIndex): Description:
Deletes a column from the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex index of the column to be deleted
| DeleteLBItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION DeleteLBItem
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteLBItem(dialogID, componentID, itemIndex): Description:
Deletes an item from the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the index of the item to delete
| EnableLB | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION EnableLB
( dialogID :LONGINT; componentID :LONGINT; enable :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.EnableLB(dialogID, componentID, enable): Description:
Enables or disables the specified list browser.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enable determines if the list browser should be enabled or disabled.
| EnableLBClickAllDataChange | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION EnableLBClickAllDataChange
( dialogID :LONGINT; componentID :LONGINT; enable :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.EnableLBClickAllDataChange(dialogID, componentID, enable): Description:
Enables all radio and multi state column data items to be changed with a single click if the alt key or option key is pressed during the click.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enable determines if all data items should be changed during the click if the appropriate modifier key is pressed.
| EnableLBColumnLines | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE EnableLBColumnLines
( dialogID :LONGINT; componentID :LONGINT; enableColumnLines :BOOLEAN ) ; Python:
return None
def vs.EnableLBColumnLines(dialogID, componentID, enableColumnLines): Description:
Enables/disables column lines.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enableColumnLines specifies if column lines should be drawn
| EnableLBColumnTracking | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE EnableLBColumnTracking
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; enableColumnTracking :BOOLEAN ) ; Python:
return None
def vs.EnableLBColumnTracking(dialogID, componentID, columnIndex, enableColumnTracking): Description:
Enables/disables column tracking.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column enableColumnTracking specifies if column tracking should be enabled or disabled
| EnableLBDragAndDrop | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION EnableLBDragAndDrop
( dialogID :LONGINT; componentID :LONGINT; enable :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.EnableLBDragAndDrop(dialogID, componentID, enable): Description:
Enables list browser drag and drop. Use SetLBDragDropColumn to set the drag and drop column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enable determines if drag and drop should be enabled
| EnableLBHierDisplay | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE EnableLBHierDisplay
( dialogID :LONGINT; componentID :LONGINT; enableHierDisplay :BOOLEAN ) ; Python:
return None
def vs.EnableLBHierDisplay(dialogID, componentID, enableHierDisplay): Description:
This function enables/disables the list browser to display items hierarchically. Calling this along will not change the display. The hierarchical display column must be set.Parameters:
dialogID The id of the dialog containing the list browser. componentID The id of the list browser. enableHierDisplay Whether to enable hierarchical display in the list browser. See Also:
SetLBHierDispColumn
| EnableLBRadioColumnLines | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE EnableLBRadioColumnLines
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; enableRadioColumnLines :BOOLEAN ) ; Python:
return None
def vs.EnableLBRadioColumnLines(dialogID, componentID, columnIndex, enableRadioColumnLines): Description:
Enables/disables radio item "column" lines.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column enableRadioColumnLines specifies if radio item "column" lines should be drawn
| EnableLBSingleLineSelection | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION EnableLBSingleLineSelection
( dialogID :LONGINT; componentID :LONGINT; enable :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.EnableLBSingleLineSelection(dialogID, componentID, enable): Description:
Enables single line only selection. Multiple selections will not be permitted.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enable determines if single line selection only should be enabled.
| EnableLBSorting | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE EnableLBSorting
( dialogID :LONGINT; componentID :LONGINT; enableSorting :BOOLEAN ) ; Python:
return None
def vs.EnableLBSorting(dialogID, componentID, enableSorting): Description:
Enables/disables sorting.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control enableSorting specifies whether to enable or disable sorting
| EnableLBUpdates | Dialogs - Modern - Browser VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE EnableLBUpdates
( liDialogID :LONGINT; liComponentID :LONGINT; bEnableUpdates :BOOLEAN ) ; Python:
return None
def vs.EnableLBUpdates(liDialogID, liComponentID, bEnableUpdates): Description:
Determines if updates should be enabled for the specified list browser.
| EnsureLBItemIsVisible | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION EnsureLBItemIsVisible
( dialogID :LONGINT; componentID :LONGINT; index :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.EnsureLBItemIsVisible(dialogID, componentID, index): Description:
Ensures the element at the given row index is visible in the specified list browser.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control index the row index
| ExpandAllLBItems | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE ExpandAllLBItems
( dialogID :LONGINT; componentID :LONGINT ) ; Python:
return None
def vs.ExpandAllLBItems(dialogID, componentID): Description:
This function is called when a list browser is in hierarchical display mode, and it redisplays all items that were hidden and opens all the containers.Parameters:
dialogID The id of the dialog. componentID The id of the list browser.
| FindLBColumnDataItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION FindLBColumnDataItem
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; itemString :STRING; VAR columnDataItemIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, columnDataItemIndex)
def vs.FindLBColumnDataItem(dialogID, componentID, columnIndex, itemString): Description:
Finds the column data item with the specified text.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column itemString the text to find columnDataItemIndex the index at which the text was found
| FindLBColumnItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION FindLBColumnItem
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; itemString :STRING; VAR itemIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, itemIndex)
def vs.FindLBColumnItem(dialogID, componentID, columnIndex, itemString): Description:
Finds the column item with the specified text.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column itemString the text to find itemIndex the index at which the text was found
| GetLBColumnDataItemInfo | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetLBColumnDataItemInfo
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; columnDataItemIndex :INTEGER; VAR itemString :STRING; VAR imageOn :INTEGER; VAR imageOff :INTEGER; VAR itemData :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, itemString, imageOn, imageOff, itemData)
def vs.GetLBColumnDataItemInfo(dialogID, componentID, columnIndex, columnDataItemIndex): Description:
Gets the specified column data item's text, image and user data.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column from which to get the data columnDataItemIndex the column data item itemString the item text imageOn the 'on' image list index imageOff the 'off' image list index itemData the item user data
| GetLBColumnHeaderJust | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBColumnHeaderJust
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; VAR justification :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, justification)
def vs.GetLBColumnHeaderJust(dialogID, componentID, columnIndex): Description:
Retrieves the specified column header's justification.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index justification Left - 1
Center - 2
Right - 3
| GetLBColumnHeaderToolTip | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBColumnHeaderToolTip
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; VAR toolTipPrimaryText :STRING; VAR toolTipSubText :STRING ) :BOOLEAN ; Python:
return (BOOLEAN, toolTipPrimaryText, toolTipSubText)
def vs.GetLBColumnHeaderToolTip(dialogID, componentID, columnIndex): Description:
Gets the list browser column header's tooltip text.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index toolTipPrimaryText the primary tooltip text toolTipSubText the sub tooltip text displayed when the user the command (Mac) or shift (Win) button
| GetLBColumnOwnerDrawnType | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBColumnOwnerDrawnType
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR ownerDrawnType :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, ownerDrawnType)
def vs.GetLBColumnOwnerDrawnType(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the list browser column's owner drawn type.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index ownerDrawnType None - 0
Solid rect - 1
Dual solid rect - 2
Pattern rect - 3
Dual pattern rect - 4
Gradient or image - 5
Blank - 6
Text - 7
Dashed line - 8
| GetLBColumnSortState | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBColumnSortState
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetLBColumnSortState(dialogID, componentID, columnIndex): Description:
Gets the column sort state.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index
| GetLBColumnWidth | Dialogs - Modern - Browser Vectorworks 2009 |
VectorScript Declaration:
FUNCTION GetLBColumnWidth
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; VAR width :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, width)
def vs.GetLBColumnWidth(dialogID, componentID, columnIndex): Description:
Gets the width of the specified column in the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column from which to get the width width width of the column
| GetLBControlType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetLBControlType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetLBControlType(dialogID, componentID, columnIndex): Description:
Gets control type for column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| GetLBEditDisplayType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetLBEditDisplayType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetLBEditDisplayType(dialogID, componentID, columnIndex): Description:
Gets edit display type for list items in specified column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| GetLBEventInfo | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBEventInfo
( dialogID :LONGINT; componentID :LONGINT; VAR eventType :INTEGER; VAR rowIndex :INTEGER; VAR columIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, eventType, rowIndex, columIndex)
def vs.GetLBEventInfo(dialogID, componentID): Description:
Retrieves the last event information for the specified list browser.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control rowIndex the row index where the click occurred. columIndex the column index where the click occurred.
| GetLBItemDashStyle | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemDashStyle
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR styleIndex :INTEGER; VAR lineWeight :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, styleIndex, lineWeight)
def vs.GetLBItemDashStyle(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's dash style.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index styleIndex the dash line's style index lineWeight the dash line's line weight
| GetLBItemData | Dialogs - Modern - Browser VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE GetLBItemData
( nDialogID :LONGINT; nComponentID :LONGINT; nItemIndex :INTEGER; nSubItemIndex :INTEGER; VAR nUserData :LONGINT ) ; Python:
return nUserData
def vs.GetLBItemData(nDialogID, nComponentID, nItemIndex, nSubItemIndex): Description:
Retrieves the user data associated with the list browser item.
| GetLBItemDisplayType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetLBItemDisplayType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetLBItemDisplayType(dialogID, componentID, columnIndex): Description:
Gets item display type for list items in specified column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| GetLBItemFillBackColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemFillBackColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR redIndex :INTEGER; VAR greenIndex :INTEGER; VAR blueIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, redIndex, greenIndex, blueIndex)
def vs.GetLBItemFillBackColor(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's fill background color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| GetLBItemFillForeColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemFillForeColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR redIndex :INTEGER; VAR greenIndex :INTEGER; VAR blueIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, redIndex, greenIndex, blueIndex)
def vs.GetLBItemFillForeColor(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's fill foreground color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| GetLBItemGradientOrImageRefNumber | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemGradientOrImageRefNumber
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR refNumber :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, refNumber)
def vs.GetLBItemGradientOrImageRefNumber(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's gradient or image.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index refNumber the gradient or image's ref number
| GetLBItemInfo | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetLBItemInfo
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR itemString :STRING; VAR imageIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, itemString, imageIndex)
def vs.GetLBItemInfo(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets string and image information for a specified item of a List Browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the item index subItemIndex the subitem index itemString the item text imageIndex the item image list index
| GetLBItemLineType | Dialogs - Modern - Browser Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetLBItemLineType
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR lineType :LONGINT; VAR lineWeight :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, lineType, lineWeight)
def vs.GetLBItemLineType(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's line type.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index lineType the line type internal index (reference number) lineWeight the line weight
| GetLBItemOrigName | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
FUNCTION GetLBItemOrigName
( dialogID :LONGINT; compenentID :LONGINT; itemIndex :INTEGER ) :STRING ; Python:
return STRING
def vs.GetLBItemOrigName(dialogID, compenentID, itemIndex): Description:
Returns the original name for a list browser item when hierarchical display is on. If the item is a container item, it will return an empty string.Parameters:
dialogID The id of the dialog. compenentID The id of the list browser. itemIndex The index of the item for which the original name is returned. Result:
The original name of the indicated item.See Also:
AddLBOriginalName
| GetLBItemPatternIndex | Dialogs - Modern - Browser Vectorworks 2010 |
VectorScript Declaration:
FUNCTION GetLBItemPatternIndex
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; the column index :INTEGER; VAR outPatIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, outPatIndex)
def vs.GetLBItemPatternIndex(dialogID, componentID, itemIndex, the column index): Description:
Gets the specified list browser item's pattern index.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index the column index the column index outPatIndex Output parameter. Returns the pattern index of this item. Value from [1..71]
| GetLBItemPenBackColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemPenBackColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR redIndex :INTEGER; VAR greenIndex :INTEGER; VAR blueIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, redIndex, greenIndex, blueIndex)
def vs.GetLBItemPenBackColor(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's pen background color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| GetLBItemPenForeColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemPenForeColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR redIndex :INTEGER; VAR greenIndex :INTEGER; VAR blueIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, redIndex, greenIndex, blueIndex)
def vs.GetLBItemPenForeColor(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the specified list browser item's pen foreground color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| GetLBItemTextColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemTextColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR redIndex :INTEGER; VAR greenIndex :INTEGER; VAR blueIndex :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, redIndex, greenIndex, blueIndex)
def vs.GetLBItemTextColor(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the text color for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| GetLBItemTextJust | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemTextJust
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR justification :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, justification)
def vs.GetLBItemTextJust(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the text alignment for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index justification Left - 1
Center - 2
Right - 3
| GetLBItemTextStyle | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBItemTextStyle
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR textStyle :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, textStyle)
def vs.GetLBItemTextStyle(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the text style for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index textStyle Plain - 0
Bold - 1
Italic - 2
Underline - 4
Outline - 16 (Mac only)
Shadow - 32 (Mac only)
| GetLBMultImageIndexes | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBMultImageIndexes
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; VAR imageIndex0 :INTEGER; VAR imageIndex1 :INTEGER; VAR imageIndex2 :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, imageIndex0, imageIndex1, imageIndex2)
def vs.GetLBMultImageIndexes(dialogID, componentID, itemIndex, subItemIndex): Description:
Gets the index of the images within the list browser multi image display.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index imageIndex0 the 'ics8' resource index of the first image imageIndex1 the 'ics8' resource index of the second image imageIndex2 the 'ics8' resource index of the third image
| GetLBOrigNameClLevel | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE GetLBOrigNameClLevel
( dialogID :LONGINT; componentID :LONGINT; originalName :STRING; VAR level1Closed :BOOLEAN; VAR level2Closed :BOOLEAN; VAR level3Closed :BOOLEAN ) ; Python:
return (level1Closed, level2Closed, level3Closed)
def vs.GetLBOrigNameClLevel(dialogID, componentID, originalName): Description:
This function returns the close levels for an original name in the list browser. If the item for the name is displayed, then all the closeLevels will be false.Parameters:
dialogID The id of the dialog. componentID The id of the list browser. originalName The original name of the item. level1Closed Whether the item's level 1 container is closed. level2Closed Whether the item's level 2 container is closed. level3Closed Whether the item's level 3 container is closed.
| GetLBSortColumn | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetLBSortColumn
( dialogID :LONGINT; componentID :LONGINT ) :INTEGER ; Python:
return INTEGER
def vs.GetLBSortColumn(dialogID, componentID): Description:
Gets the index of the sort column in the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| GetNumLBColumnDataItems | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetNumLBColumnDataItems
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetNumLBColumnDataItems(dialogID, componentID, columnIndex): Description:
Get the number of columnDataItems.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| GetNumLBColumns | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetNumLBColumns
( dialogID :LONGINT; componentID :LONGINT ) :INTEGER ; Python:
return INTEGER
def vs.GetNumLBColumns(dialogID, componentID): Description:
Gets the number of columns in the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| GetNumLBItems | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION GetNumLBItems
( dialogID :LONGINT; componentID :LONGINT ) :INTEGER ; Python:
return INTEGER
def vs.GetNumLBItems(dialogID, componentID): Description:
Gets the number of items in the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control Result:
Returns the number of items in the list browser.
| GetNumSelectedLBItems | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetNumSelectedLBItems
( dialogID :LONGINT; componentID :LONGINT ) :INTEGER ; Python:
return INTEGER
def vs.GetNumSelectedLBItems(dialogID, componentID): Description:
Returns the number of selected list browser items.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| HierLBItemClosed | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE HierLBItemClosed
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; recursive :BOOLEAN ) ; Python:
return None
def vs.HierLBItemClosed(dialogID, componentID, itemIndex, recursive): Description:
This function is called when the user clicks on a container item to close it. It will remove items that are inside the container being closed.Parameters:
dialogID The id of the dialog containing the list browser. componentID The id of the list browser. itemIndex The index of the item that was clicked on. recursive Whether to also close any containers inside the container that was clicked on. See Also:
HierLBItemOpened
| HierLBItemIsClosed | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
FUNCTION HierLBItemIsClosed
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.HierLBItemIsClosed(dialogID, componentID, itemIndex): Description:
Returns whether the indicated container item is closed.Parameters:
dialogID The id of the dialog. componentID The id of the list browser. itemIndex The index of the item.
| HierLBItemIsContain | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
FUNCTION HierLBItemIsContain
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.HierLBItemIsContain(dialogID, componentID, itemIndex): Description:
Returns whether the indicated item is a container item.Parameters:
dialogID The id of the dialog containing the list browser. componentID The ID of the list browser. itemIndex The index of the item. Result:
Whether the indicated item is a container item.See Also:
HierLBItemIsClosed
| HierLBItemOpened | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE HierLBItemOpened
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; recursive :BOOLEAN; VAR numbRedisplItems :INTEGER ) ; Python:
return numbRedisplItems
def vs.HierLBItemOpened(dialogID, componentID, itemIndex, recursive): Description:
This function is called when the user clicks on a container item to open it. It wil redisplay items inside the container that were hidden (unless they are inside a lower level container that is closed), but only with the hierarchical name set. If other data needs to be redisplayed, it will need to be done with other functions. numbRedisplItems indicates how many non-container items were redisplayed.Parameters:
dialogID The id of the dialog containing the list browser. componentID The id of the list browser. itemIndex The index of the item that was clicked on. recursive Indicates whether any subcontainers should also be opened. numbRedisplItems The number of items that were redisplayed. See Also:
HierLBItemClosed
| InsertLBColumn | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION InsertLBColumn
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; headerString :STRING; width :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.InsertLBColumn(dialogID, componentID, columnIndex, headerString, width): Description:
Inserts a column into the specified list browser control. Returns index of created column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex index at which the column is to be inserted headerString text to set as column header width the width of the column in pixels
| InsertLBColumnDataItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION InsertLBColumnDataItem
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; itemString :STRING; imageOn :INTEGER; imageOff :INTEGER; itemData :LONGINT ) :INTEGER ; Python:
return INTEGER
def vs.InsertLBColumnDataItem(dialogID, componentID, columnIndex, itemString, imageOn, imageOff, itemData): Description:
Inserts column data item with specified data. Returns the index to the newly inserted item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column for which to set the data itemString the item text imageOn the 'on' image list index imageOff the 'off' image list index itemData the item user data
| InsertLBItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION InsertLBItem
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; itemString :STRING ) :INTEGER ; Python:
return INTEGER
def vs.InsertLBItem(dialogID, componentID, itemIndex, itemString): Description:
Insert an item into the specified list browser control. Returns the index of the created item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex index at which the item is to be inserted itemString text to set for item
| IsLBColumnTrackingEnabled | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION IsLBColumnTrackingEnabled
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsLBColumnTrackingEnabled(dialogID, componentID, columnIndex): Description:
Determines if column tracking is enabled for the specified column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| IsLBDisplayHier | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
FUNCTION IsLBDisplayHier
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsLBDisplayHier(dialogID, componentID): Description:
Returns whether the indicated list browser is set to display items hierarchically. One column in the list browser can be set to display names heirarchically.Parameters:
dialogID The id of the dialog containing the list browser. componentID The id of the list browser. See Also:
EnableLBHierDisplay
| IsLBItemSelected | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION IsLBItemSelected
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsLBItemSelected(dialogID, componentID, itemIndex): Description:
Determines if the specified item is currently selected.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row number
| IsLBSortingEnabled | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION IsLBSortingEnabled
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsLBSortingEnabled(dialogID, componentID): Description:
Determines if sorting is enabled or disabled.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| RefreshLB | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION RefreshLB
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.RefreshLB(dialogID, componentID): Description:
Refreshes the contents of the specified list browser.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| RemoveAllLBColumnDataItems | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
PROCEDURE RemoveAllLBColumnDataItems
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) ; Python:
return None
def vs.RemoveAllLBColumnDataItems(dialogID, componentID, columnIndex): Description:
Removes all column data items.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column
| RemoveLBColumnDataItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION RemoveLBColumnDataItem
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; columnDataItemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.RemoveLBColumnDataItem(dialogID, componentID, columnIndex, columnDataItemIndex): Description:
Removes the specified column data item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column columnDataItemIndex the column data item to remove
| SetFocusOnLB | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetFocusOnLB
( dialogID :LONGINT; componentID :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetFocusOnLB(dialogID, componentID): Description:
Sets the keyboard/input focus on the specified list browser.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control
| SetLBColumnHeaderJust | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBColumnHeaderJust
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; justification :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBColumnHeaderJust(dialogID, componentID, columnIndex, justification): Description:
Sets the specified column header's justification.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index justification Left - 1
Center - 2
Right - 3
| SetLBColumnHeaderToolTip | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBColumnHeaderToolTip
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; toolTipPrimaryText :STRING; toolTipSubText :STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBColumnHeaderToolTip(dialogID, componentID, columnIndex, toolTipPrimaryText, toolTipSubText): Description:
Sets the list browser column header's tooltip text.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index toolTipPrimaryText the primary tooltip text toolTipSubText the sub tooltip text displayed when the user the command (Mac) or shift (Win) button
| SetLBColumnImage | Dialogs - Modern - Browser VectorWorks 2008 |
VectorScript Declaration:
FUNCTION SetLBColumnImage
( nDialogID :LONGINT; nComponentID :LONGINT; nColumnIndex :INTEGER; nImageIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBColumnImage(nDialogID, nComponentID, nColumnIndex, nImageIndex): Description:
Draws an icon instead of text on a list browser header column. Use with AddLBImage.
| SetLBColumnOwnerDrawnType | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBColumnOwnerDrawnType
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; ownerDrawnType :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBColumnOwnerDrawnType(dialogID, componentID, itemIndex, subItemIndex, ownerDrawnType): Description:
Sets the list browser column's owner drawn type.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index ownerDrawnType None - 0
Solid rect - 1
Dual solid rect - 2
Pattern rect - 3
Dual pattern rect - 4
Gradient or image - 5
Blank - 6
Text - 7
Dashed line - 8
| SetLBColumnWidth | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBColumnWidth
( dialogID :LONGINT; componentID :LONGINT; fromColumn :INTEGER; toColumn :INTEGER; width :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBColumnWidth(dialogID, componentID, fromColumn, toColumn, width): Description:
Sets the width of the specified range of columns of the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control fromColumn first column to be changed toColumn last column to be changed width the width of the column in pixels
| SetLBControlType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBControlType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; controlType :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBControlType(dialogID, componentID, columnIndex, controlType): Description:
Sets control type for column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column controlType the control type to be set (1: Static, 2: Radio, 3: Multi State, 4: Single Instance Icon [See Organization Dialog active element column], 5: Static Icon, 6: Number, 7: Multiple Icons)
| SetLBDragDropColumn | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBDragDropColumn
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBDragDropColumn(dialogID, componentID, columnIndex): Description:
Sets the drag and drop column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index
| SetLBEditDisplayType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBEditDisplayType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; displayType :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBEditDisplayType(dialogID, componentID, columnIndex, displayType): Description:
Sets edit display type for list items in specified column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column displayType the display type to be set (0: Text Only, 1: Icon Only, 3: Text and Icon)
| SetLBHierDispColumn | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE SetLBHierDispColumn
( dialogID :LONGINT; componentID :LONGINT; columnID :INTEGER ) ; Python:
return None
def vs.SetLBHierDispColumn(dialogID, componentID, columnID): Description:
This function sets which column to display hierarchically in a list browser. This will only work on a text column. Items with dashes in the string value for the hierarchical column will be displayed hierarchically. This will work on items already entered. When new items are entered, this will need to be called again.Parameters:
dialogID The id of the dialog. componentID The id of the list browser. columnID The index of the hierarchical column. See Also:
EnableLBHierDisplay
| SetLBItemDashStyle | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemDashStyle
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; styleIndex :INTEGER; lineWeight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemDashStyle(dialogID, componentID, itemIndex, subItemIndex, styleIndex, lineWeight): Description:
Sets the specified list browser item's dash style.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index styleIndex the dash line's style index lineWeight the dash line's line weight
| SetLBItemData | Dialogs - Modern - Browser VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetLBItemData
( nDialogID :LONGINT; nComponentID :LONGINT; nItemIndex :INTEGER; nSubItemIndex :INTEGER; nUserData :LONGINT ) ; Python:
return None
def vs.SetLBItemData(nDialogID, nComponentID, nItemIndex, nSubItemIndex, nUserData): Description:
Sets the user data associated with the list browser item.
| SetLBItemDisplayType | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBItemDisplayType
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; displayType :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemDisplayType(dialogID, componentID, columnIndex, displayType): Description:
Sets item display type for list items in specified column.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the index of the column displayType the display type to be set (0: Text Only, 1: Icon Only, 3: Text and Icon)
| SetLBItemFillBackColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemFillBackColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; redIndex :INTEGER; greenIndex :INTEGER; blueIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemFillBackColor(dialogID, componentID, itemIndex, subItemIndex, redIndex, greenIndex, blueIndex): Description:
Sets the specified list browser item's fill background color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| SetLBItemFillForeColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemFillForeColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; redIndex :INTEGER; greenIndex :INTEGER; blueIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemFillForeColor(dialogID, componentID, itemIndex, subItemIndex, redIndex, greenIndex, blueIndex): Description:
Sets the specified list browser item's fill foreground color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| SetLBItemGradientOrImageRefNumber | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemGradientOrImageRefNumber
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; refNumber :LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemGradientOrImageRefNumber(dialogID, componentID, itemIndex, subItemIndex, refNumber): Description:
Sets the specified list browser item's gradient or image.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index refNumber the gradient or image's ref number
| SetLBItemInfo | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBItemInfo
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; itemString :STRING; imageIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemInfo(dialogID, componentID, itemIndex, subItemIndex, itemString, imageIndex): Description:
Sets data for item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the item index subItemIndex the subitem index itemString the item text imageIndex the item image list index
| SetLBItemLineType | Dialogs - Modern - Browser Vectorworks 2015 |
VectorScript Declaration:
FUNCTION SetLBItemLineType
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; lineType :LONGINT; lineWeight :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemLineType(dialogID, componentID, itemIndex, subItemIndex, lineType, lineWeight): Description:
Sets the specified list browser item's line type.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index lineType the line type internal index (reference number) lineWeight the line weight
| SetLBItemPatternIndex | Dialogs - Modern - Browser Vectorworks 2010 |
VectorScript Declaration:
FUNCTION SetLBItemPatternIndex
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; patIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemPatternIndex(dialogID, componentID, itemIndex, subItemIndex, patIndex): Description:
Sets the specified list browser item's pattern index.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index patIndex The pattern index of this item. Value from [1..71]
| SetLBItemPenBackColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemPenBackColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; redIndex :INTEGER; greenIndex :INTEGER; blueIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemPenBackColor(dialogID, componentID, itemIndex, subItemIndex, redIndex, greenIndex, blueIndex): Description:
Sets the specified list browser item's pen background color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| SetLBItemPenForeColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemPenForeColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; redIndex :INTEGER; greenIndex :INTEGER; blueIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemPenForeColor(dialogID, componentID, itemIndex, subItemIndex, redIndex, greenIndex, blueIndex): Description:
Sets the specified list browser item's pen foreground color.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| SetLBItemTextColor | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemTextColor
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; redIndex :INTEGER; greenIndex :INTEGER; blueIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemTextColor(dialogID, componentID, itemIndex, subItemIndex, redIndex, greenIndex, blueIndex): Description:
Sets the text color for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index redIndex the red component (0 - 255) greenIndex the green component (0 - 255) blueIndex the blue component (0 - 255)
| SetLBItemTextJust | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemTextJust
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; justification :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemTextJust(dialogID, componentID, itemIndex, subItemIndex, justification): Description:
Sets the text alignment for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index justification Left - 1
Center - 2
Right - 3
| SetLBItemTextStyle | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetLBItemTextStyle
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; textStyle :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemTextStyle(dialogID, componentID, itemIndex, subItemIndex, textStyle): Description:
Sets the text style for the specified list browser item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index textStyle Plain - 0
Bold - 1
Italic - 2
Underline - 4
Outline - 16 (Mac only)
Shadow - 32 (Mac only)
| SetLBItemUsingColumnDataItem | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBItemUsingColumnDataItem
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; columnDataItemIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBItemUsingColumnDataItem(dialogID, componentID, itemIndex, subItemIndex, columnDataItemIndex): Description:
Sets list item data with specified column data item.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index columnDataItemIndex the column data item with which to set list item data
| SetLBMultImageIndexes | Dialogs - Modern - Browser VectorWorks12.0 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetLBMultImageIndexes
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; imageIndex0 :INTEGER; imageIndex1 :INTEGER; imageIndex2 :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBMultImageIndexes(dialogID, componentID, itemIndex, subItemIndex, imageIndex0, imageIndex1, imageIndex2): Special Notes:
SetLBMultImageIndexes is obsolete as of Vectorworks 2012
Description:
Sets the index of the images within the list browser multi image display.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control itemIndex the row index subItemIndex the column index imageIndex0 the 'ics8' resource index of the first image imageIndex1 the 'ics8' resource index of the second image imageIndex2 the 'ics8' resource index of the third image
| SetLBNumericItemInfo | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
FUNCTION SetLBNumericItemInfo
( dialogID :LONGINT; componentID :LONGINT; itemIndex :INTEGER; subItemIndex :INTEGER; itemString :STRING; itemNumVal :REAL; imageIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBNumericItemInfo(dialogID, componentID, itemIndex, subItemIndex, itemString, itemNumVal, imageIndex): Description:
Sets numeric data for item.Parameters:
dialogID ID of the dialog that contains the list browser. componentID ID of the list browser control itemIndex the item index subItemIndex the subitem index itemString the item text itemNumVal the item numeric value imageIndex the item image list index
| SetLBOrigNameClLevel | Dialogs - Modern - Browser Vectorworks 2013 |
VectorScript Declaration:
PROCEDURE SetLBOrigNameClLevel
( dialogID :LONGINT; componentID :LONGINT; originalName :STRING; level1Closed :BOOLEAN; level2Closed :BOOLEAN; level3Closed :BOOLEAN ) ; Python:
return None
def vs.SetLBOrigNameClLevel(dialogID, componentID, originalName, level1Closed, level2Closed, level3Closed): Description:
This function sets the closed levels for an original item in the list browser. The item will be hidden and the proper container closed.Parameters:
dialogID The id of the dialog. componentID The id of the list browser. originalName The original name of the item. level1Closed Whether the item's level 1 container is closed. level2Closed Whether the item's level 2 container is closed. level3Closed Whether the item's level 3 container is closed.
| SetLBSelection | Dialogs - Modern - Browser VectorWorks11.0 |
VectorScript Declaration:
FUNCTION SetLBSelection
( dialogID :LONGINT; componentID :LONGINT; firstItemIndex :INTEGER; lastItemIndex :INTEGER; select :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLBSelection(dialogID, componentID, firstItemIndex, lastItemIndex, select): Description:
Selects the specified range of items within a List Browser dialog control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control firstItemIndex the first row of the range to select lastItemIndex the last row of the range to select select select or deselect Result:
True for success, false otherwise.
| SetLBSortColumn | Dialogs - Modern - Browser VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetLBSortColumn
( dialogID :LONGINT; componentID :LONGINT; columnIndex :INTEGER; isAscending :BOOLEAN ) ; Python:
return None
def vs.SetLBSortColumn(dialogID, componentID, columnIndex, isAscending): Description:
Sets the specified column as the sort column in the specified list browser control.Parameters:
dialogID id of the dialog that contains the list browser componentID id of the list browser control columnIndex the column index isAscending determines if the sort should be ascending or descending
| ShowLBHeader | Dialogs - Modern - Browser Vectorworks 2015 |
VectorScript Declaration:
PROCEDURE ShowLBHeader
( dialogID :LONGINT; componentID :LONGINT; show :BOOLEAN ) ; Python:
return None
def vs.ShowLBHeader(dialogID, componentID, show): Description:
Shows or hides header row for a list browser control in a dialog