PropertyListBox

From Jeremie Leroy - XOJO Controls Wiki
Revision as of 08:41, 2 May 2012 by RB WikiCreator (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


The control is XML-driven, which means that the best way to display something in it, is to load an XML definition file specially made for it.

To use this control, just drag it in a window, and in the open event, load an XML file, using the method: "me. LoadFromXML(XMLString As String)".

Events
ButtonPressed ContentsChanged
CellAction DoubleClick
CellClick LoadingValueList
CellColorClick Open
CellCustomEdit ShouldTriggerAutocomplete
CellValueChanged


Properties
AutoCompleteMode CustomGridLinesVertical PropertyString
BBCode DefaultType RBColorDisplay
ButtonColor defaultvalueStyle Star
ButtonEdit headerStyle SyntaxComment
ButtonPopupArrow LastEditCell TransparentString
ColonString LastError ValueString
ColorGutter LastValue valueStyle
CustomButtons LineCount
CustomGridLinesColor MacOSStyle
CustomGridLinesHorizontal nameStyle



Methods
CellValue NewRow
CellValue Reload
GetLine toXML
GetLine ValuesForHeader
LoadFromXML


Shared Methods
Register


Notes

XML definition

You can use this example as XML definition to load in the PropertyListBox.

<?xml version="1.0" encoding="UTF-8"?>
<PropertyListBox version="1.1">
<name>PropertyListbox Example</name>
<button id="0" text="Help"/>
<contents>
<header visible="True" expanded="True">
<name>Cell Types</name>
<param type="1" visible="True">
<name>Normal</name>
<value>Normal Text</value>
</param>
<param type="2" visible="True">
<name>CheckBox</name>
<value>False</value>
</param>
<param type="3" visible="True">
<name>Editable</name>
<value>Click to edit</value>
</param>
<param type="4" visible="True">
<name>Multiline Text</name>
<value>Click to edit
</value>
</param>
<param type="5" visible="True" required="True">
<name>List</name>
<valuelist>Red|Green|Blue</valuelist>
</param>
<param type="6" visible="True">
<name>Editable List</name>
<valuelist>Red|Green|Blue</valuelist>
</param>
<param type="6" visible="True" autocomplete="True">
<name>Autocomplete List</name>
<valuelist>font_list</valuelist>
</param>
<param type="7" visible="True">
<name>Color</name>
<value>&amp;cDBDFFF</value>
</param>
<param type="8" visible="True">
<name>FolderItem (File)</name>
</param>
<param type="8" visible="True" folder="True">
<name>FolderItem (Folder)</name>
</param>
<param type="9" visible="True">
<name>RadioButton 1</name>
<value>True</value>
<helptag>Only one RadioButton per header can be checked at at time.
RadioButton appear as checkboxes.
However, RadioButtons and Checkboxes are independant</helptag>
</param>
<param type="9" visible="True">
<name>RadioButton 2</name>
<value>False</value>
<helptag>Only one RadioButton per header can be checked at at time.
RadioButton appear as checkboxes.
However, RadioButtons and Checkboxes are independant</helptag>
</param>
<param type="9" visible="True">
<name>RadioButton 3</name>
<value>False</value>
<helptag>Only one RadioButton per header can be checked at at time.
RadioButton appear as checkboxes.
However, RadioButtons and Checkboxes are independant</helptag>
</param>
<param type="10" visible="True">
<name>Rating</name>
<value>3</value>
</param>
</header>
<header visible="True" expanded="True" button="0">
<name>Header with Button</name>
<param type="2" visible="True">
<name>Show Invisible Lines</name>
<value>False</value>
</param>
<param type="1" visible="False">
<name>Invisible Line 1</name>
</param>
<param type="1" visible="False">
<name>Invisible Line 2</name>
</param>
<param type="2" visible="False">
<name>Show Invisible Header</name>
<value>False</value>
</param>
</header>
<header visible="False" expanded="True">
<name>Invisible Header</name>
<param type="1" visible="True">
<name>No value</name>
</param>
</header>
</contents>
<style>
<header UpdateStyle="False">
<backColor>#DBDFFF</backColor>
<bold>True</bold>
<highlightcolor>#3399FF</highlightcolor>
<italic>False</italic>
<textalign>0</textalign>
<textcolor>#000000</textcolor>
<textfont>System</textfont>
<texthighlightcolor>#FFFFFF</texthighlightcolor>
<textsize>0</textsize>
<underline>False</underline>
</header>
<name UpdateStyle="False">
<backColor>#FFFFFF</backColor>
<bold>False</bold>
<highlightcolor>#3399FF</highlightcolor>
<italic>False</italic>
<textalign>2</textalign>
<textcolor>#000000</textcolor>
<textfont>System</textfont>
<texthighlightcolor>#FFFFFF</texthighlightcolor>
<textsize>0</textsize>
<underline>False</underline>
</name>
<value UpdateStyle="False">
<backColor>#FFFFFF</backColor>
<bold>False</bold>
<highlightcolor>#3399FF</highlightcolor>
<italic>False</italic>
<textalign>0</textalign>
<textcolor>#000000</textcolor>
<textfont>System</textfont>
<texthighlightcolor>#FFFFFF</texthighlightcolor>
<textsize>0</textsize>
<underline>False</underline>
</value>
<ColonString>:</ColonString>
<PropertyString>Property</PropertyString>
<ValueString>Value</ValueString>
<TransparentString>transparent</TransparentString>
<Border>True</Border>
<ColumnWidths>50% 50%, 1*</ColumnWidths>
<GridLinesHorizontal>0</GridLinesHorizontal>
<GridLinesVertical>0</GridLinesVertical>
<HasHeading>True</HasHeading>
<ScrollBarHorizontal>False</ScrollBarHorizontal>
<ScrollBarVertical>True</ScrollBarVertical>
<DefaultRowHeight>-1</DefaultRowHeight>
<AutoHideScrollbars>True</AutoHideScrollbars>
<Hierarchical>True</Hierarchical>
</style>
</PropertyListBox>


See Also

BBCodeStorage, PropertyListButton, PropertyListLine, [[PropertyListStyle classes. PropertyListModule module. Listbox control.]]