Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:propertylist [2019/06/06 21:50]
agcyphers [Events]
desktop:propertylist [2019/10/23 05:53] (current)
Line 3: Line 3:
 [[desktop:​propertylistchild|GraffitiPropertyListChild]] [[desktop:​propertylistchild|GraffitiPropertyListChild]]
  
-This class inherits from [[http://developer.xojo.com/listbox|ListBox]], so much of that functionality is also available.+This class inherits from [[http://docs.xojo.com/ListBox|ListBox]], so much of that functionality is also available.
  
 ==== Enumerations ==== ==== Enumerations ====
Line 19: Line 19:
 | CustomIconPaint(Node as PropertyListChild,​ X as Integer, Y as Integer) | Fired when the icon is being painted for a cell of type of kChildCustom. | | CustomIconPaint(Node as PropertyListChild,​ X as Integer, Y as Integer) | Fired when the icon is being painted for a cell of type of kChildCustom. |
 | ExpandHeader( currHeader as PropertyListHeader ) | Fired when a header is expanded. | | ExpandHeader( currHeader as PropertyListHeader ) | Fired when a header is expanded. |
-| HeaderBackgroundPaint( g as [[http://developer.xojo.com/graphics|Graphics]] ) As [[http://developer.xojo.com/boolean|Boolean]] | Fired before any background painting is carried out on headers. ​ Return true if you draw to the graphics context. |+| HeaderBackgroundPaint( g as [[https://docs.xojo.com/Graphics|Graphics]] ) As [[https://docs.xojo.com/Boolean|Boolean]] | Fired before any background painting is carried out on headers. ​ Return true if you draw to the graphics context. |
 | MouseOver( currHeader as PropertyListHeader,​ currChild as PropertyListChild ) | Raised when the user mouses over a head or child. | | MouseOver( currHeader as PropertyListHeader,​ currChild as PropertyListChild ) | Raised when the user mouses over a head or child. |
-| NameBackgroundPaint( g as [[http://developer.xojo.com/graphics|Graphics]],​ IsSelected as [[http://developer.xojo.com/​Boolean|Boolean]] ) As [[http://developer.xojo.com/boolean|Boolean]] | Raised before drawing is carried on child name backgrounds. ​ Return true if you modify the graphics context. | +| NameBackgroundPaint( g as [[https://docs.xojo.com/Graphics|Graphics]],​ IsSelected as [[https://docs.xojo.com/​Boolean|Boolean]] ) As [[https://docs.xojo.com/Boolean|Boolean]] | Raised before drawing is carried on child name backgrounds. ​ Return true if you modify the graphics context. | 
-| UnusedBackgroundPaint( g as [[http://developer.xojo.com/graphics|Graphics]] ) As [[http://developer.xojo.com/boolean|Boolean]] | Triggered when the class is about to draw empty rows.  Return True if you modify the graphics context. | +| UnusedBackgroundPaint( g as [[https://docs.xojo.com/Graphics|Graphics]] ) As [[https://docs.xojo.com/Boolean|Boolean]] | Triggered when the class is about to draw empty rows.  Return True if you modify the graphics context. | 
-| ValueChange( Node as PropertyListChild ​Tag As [[http://developer.xojo.com/string|String]] = ""​ ) | Fired when the value of a PropertyListChild has changed. |+| ValueChange( Node as PropertyListChildTag As [[https://docs.xojo.com/String|String]] = ""​ ) | Fired when the value of a PropertyListChild has changed. |
  
 ==== Methods ==== ==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| CBool( Value As [[http://developer.xojo.com/string|String]] ) As [[http://developer.xojo.com/boolean|Boolean]] ​| This class exposes no methods. ​| Converts a string to a boolean value. | +| CBool( Value As [[https://docs.xojo.com/String|String]] ) As [[https://docs.xojo.com/Boolean|Boolean]] | Converts a string to a boolean value. | 
-| FindChild( childText as [[http://developer.xojo.com/string|String]], childValue as [[http://developer.xojo.com/string|String]] ) as PropertyListChild | Find the child matching the specified criteria. | +| FindChild( childText as [[https://docs.xojo.com/String|String]], childValue as [[https://docs.xojo.com/String|String]] ) as PropertyListChild | Find the child matching the specified criteria. | 
-| FindChildInHeader( HeaderText as [[http://developer.xojo.com/string|String]], ChildName as [[http://developer.xojo.com/string|String]] ) as GraffitiPropertyListChild | ::: | +| FindChildInHeader( HeaderText as [[https://docs.xojo.com/​String]],​ ChildName as [[https://docs.xojo.com/String|String]] ) as GraffitiPropertyListChild | ::: | 
-| FindHeader( HeaderText as [[http://developer.xojo.com/string|String]] ) as PropertyListHeader | Find the header matching the specified criteria. |+| FindHeader( HeaderText as [[https://docs.xojo.com/String|String]] ) as PropertyListHeader | Find the header matching the specified criteria. |
 | FindHeaderByChild( SearchChild as PropertyListChild ) as PropertyListHeader | ::: | | FindHeaderByChild( SearchChild as PropertyListChild ) as PropertyListHeader | ::: |
-| FromXML( XMLString as [[http://developer.xojo.com/string|String]] ) | Populates the propertylist from an XML string. | +| FromXML( XMLString as [[https://docs.xojo.com/String|String]] ) | Populates the propertylist from an XML string. | 
-| GetColorPicture( c as [[http://developer.xojo.com/color|Color]], intWidth as [[http://developer.xojo.com/integer|Integer]], intHeight as [[http://developer.xojo.com/integer|Integer]] ) as [[http://developer.xojo.com/picture|Picture]] | Creates an image for a color. |+| GetColorPicture( c as [[https://docs.xojo.com/Color|Color]], intWidth as [[https://docs.xojo.com/Integer|Integer]], intHeight as [[https://docs.xojo.com/Integer|Integer]] ) as [[https://docs.xojo.com/Picture|Picture]] | Creates an image for a color. |
 | LockUpdate() | Prevents the UI from updating until UnlockUpdate is called. | | LockUpdate() | Prevents the UI from updating until UnlockUpdate is called. |
 | Reload() | Clears and rebuild the component'​s display. | | Reload() | Clears and rebuild the component'​s display. |
-| RemoveHeader( HeaderText as [[http://developer.xojo.com/string|String]] ) as [[http://developer.xojo.com/boolean|Boolean]] | Removes a header from the display. | +| RemoveHeader( HeaderText as [[https://docs.xojo.com/String|String]] ) as [[https://docs.xojo.com/Boolean|Boolean]] | Removes a header from the display. | 
-| ToXML() as [[http://developer.xojo.com/string|String]] | Exports the current state to an XML string. |+| ToXML() as [[https://docs.xojo.com/String|String]] | Exports the current state to an XML string. |
 | UnlockUpdate() | Updates the UI of any changes carried out during the LockUpdate period. | | UnlockUpdate() | Updates the UI of any changes carried out during the LockUpdate period. |
  
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| AutoEdit | [[http://developer.xojo.com/boolean|Boolean]] | True | If True, clicking a value cell automatically begins editing. | +| AutoEdit | [[https://docs.xojo.com/Boolean|Boolean]] | True | If True, clicking a value cell automatically begins editing. | 
-| Button_Browse | [[http://developer.xojo.com/picture|Picture]] | Nil | Picture to use for file browsing button. | +| Button_Browse | [[https://docs.xojo.com/Picture|Picture]] | Nil | Picture to use for file browsing button. | 
-| Button_Edit | [[http://developer.xojo.com/picture|Picture]] | Nil | Picture to use for text edit button. | +| Button_Edit | [[https://docs.xojo.com/Picture|Picture]] | Nil | Picture to use for text edit button. | 
-| Button_Int | [[http://developer.xojo.com/picture|Picture]] | Nil | Picture to use for integer edit button. | +| Button_Int | [[https://docs.xojo.com/Picture|Picture]] | Nil | Picture to use for integer edit button. | 
-| Button_Popup | [[http://developer.xojo.com/picture|Picture]] | Nil | Picture to use for popup button. | +| Button_Popup | [[https://docs.xojo.com/Picture|Picture]] | Nil | Picture to use for popup button. | 
-| CustomStyle | [[http://developer.xojo.com/boolean|Boolean]] | Nil | If true, will use custom color properties for drawing. | +| CustomStyle | [[https://docs.xojo.com/Boolean|Boolean]] | Nil | If true, will use custom color properties for drawing. | 
-| ExpanderColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Color applied to the row tree expanders. | +| ExpanderColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Color applied to the row tree expanders. | 
-| HeaderBGColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Background color for header items. | +| HeaderBGColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Background color for header items. | 
-| HeaderBold | [[http://developer.xojo.com/boolean|Boolean]] | False | Font weight of header item text. | +| HeaderBold | [[https://docs.xojo.com/Boolean|Boolean]] | False | Font weight of header item text. | 
-| HeaderItalic | [[http://developer.xojo.com/boolean|Boolean]] | False | Text decoration of header text. |+| HeaderItalic | [[https://docs.xojo.com/Boolean|Boolean]] | False | Text decoration of header text. |
 | Headers() | PropertyListHeader | Nil | Array of header items. ​ Changes to this property will not be propagated unless you call Reload(). | | Headers() | PropertyListHeader | Nil | Array of header items. ​ Changes to this property will not be propagated unless you call Reload(). |
-| HeaderTextColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Text color of header items. | +| HeaderTextColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Text color of header items. | 
-| HeaderTextFont | [[http://developer.xojo.com/string|String]] | "​System"​ | Text font of header items. | +| HeaderTextFont | [[https://docs.xojo.com/String|String]] | "​System"​ | Text font of header items. | 
-| HeaderTextSize | [[http://developer.xojo.com/integer|Integer]] | 0 | Font size of header items. | +| HeaderTextSize | [[https://docs.xojo.com/Integer|Integer]] | 0 | Font size of header items. | 
-| HeaderUnderline | [[http://developer.xojo.com/boolean|Boolean]] | False | Text decoration of header text. | +| HeaderUnderline | [[https://docs.xojo.com/Boolean|Boolean]] | False | Text decoration of header text. | 
-| IconColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Color applied to the edit icons for rows' values. | +| IconColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Color applied to the edit icons for rows' values. | 
-| NameBGColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Background color of child names. | +| NameBGColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Background color of child names. | 
-| NameBGHighlight | [[http://developer.xojo.com/color|Color]] | &​c000000 | Background highlight color of child names. | +| NameBGHighlight | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Background highlight color of child names. | 
-| NameBold | [[http://developer.xojo.com/boolean|Boolean]] | False | Font weight of child names. | +| NameBold | [[https://docs.xojo.com/Boolean|Boolean]] | False | Font weight of child names. | 
-| NameItalic | [[http://developer.xojo.com/boolean|Boolean]] | False | Italicize child names. | +| NameItalic | [[https://docs.xojo.com/Boolean|Boolean]] | False | Italicize child names. | 
-| NameTextColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Text color of child names. | +| NameTextColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Text color of child names. | 
-| NameTextFont | [[http://developer.xojo.com/string|String]] | "​System"​ | Text font of child names. | +| NameTextFont | [[https://docs.xojo.com/String|String]] | "​System"​ | Text font of child names. | 
-| NameTextSize | [[http://developer.xojo.com/integer|Integer]] | 0 | Font size of child names. | +| NameTextSize | [[https://docs.xojo.com/Integer|Integer]] | 0 | Font size of child names. | 
-| NameUnderline | [[http://developer.xojo.com/boolean|Boolean]] | False | Text decoration of child names. | +| NameUnderline | [[https://docs.xojo.com/Boolean|Boolean]] | False | Text decoration of child names. | 
-| ResizeColumns | [[http://developer.xojo.com/boolean|Boolean]] | False | Allow users to resize columns. | +| ResizeColumns | [[https://docs.xojo.com/Boolean|Boolean]] | False | Allow users to resize columns. | 
-| RowHeight | [[http://developer.xojo.com/integer|Integer]] | 32 | The height of each row. | +| RowHeight | [[https://docs.xojo.com/Integer|Integer]] | 32 | The height of each row. | 
-| UnusedBGColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Color used to fill unused area of the control. | +| UnusedBGColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Color used to fill unused area of the control. | 
-| ValueBGColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Background color of child values. | +| ValueBGColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Background color of child values. | 
-| ValueBGHighlight | [[http://developer.xojo.com/color|Color]] | &​c000000 | Background highlight color of child values. | +| ValueBGHighlight | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Background highlight color of child values. | 
-| ValueBold | [[http://developer.xojo.com/boolean|Boolean]] | False | Font weight of child values. | +| ValueBold | [[https://docs.xojo.com/Boolean|Boolean]] | False | Font weight of child values. | 
-| ValueItalic | [[http://developer.xojo.com/boolean|Boolean]] | False | Italicize child values. | +| ValueItalic | [[https://docs.xojo.com/Boolean|Boolean]] | False | Italicize child values. | 
-| ValueTextColor | [[http://developer.xojo.com/color|Color]] | &​c000000 | Text color of child values. | +| ValueTextColor | [[https://docs.xojo.com/Color|Color]] | &​c000000 | Text color of child values. | 
-| ValueTextFont | [[http://developer.xojo.com/string|String]] | "​System"​ | Text font of child values. | +| ValueTextFont | [[https://docs.xojo.com/String|String]] | "​System"​ | Text font of child values. | 
-| ValueTextSize | [[http://developer.xojo.com/integer|Integer]] | 0 | Font size of child values. | +| ValueTextSize | [[https://docs.xojo.com/Integer|Integer]] | 0 | Font size of child values. | 
-| ValueUnderline | [[http://developer.xojo.com/boolean|Boolean]] | False | Text decoration of child values. |+| ValueUnderline | [[https://docs.xojo.com/Boolean|Boolean]] | False | Text decoration of child values. |
  
 ==== Examples ==== ==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.