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:tagfield [2017/04/10 04:30]
agcyphers [Properties]
desktop:tagfield [2018/04/14 16:09] (current)
Line 1: Line 1:
-====== ​Enumerations ​======+==== See Also ==== 
 +[[desktop:​tagfielditem|GraffitiTagFieldItem]] 
 + 
 +==== Enumerations ​====
 ^ Name      ^ Values ​      ^ ^ Name      ^ Values ​      ^
 |  | This class exposes no enumerations. | |  | This class exposes no enumerations. |
  
-====== Constants ​======+==== Constants ====
 ^ Name      ^ Type     ^ Value       ^ ^ Name      ^ Type     ^ Value       ^
 |  |  | This class exposes no constants. | |  |  | This class exposes no constants. |
  
-====== Events ​======+==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| HeightChanged( OldHeight as Integer ) | If AdaptiveHeight is True, this will fire when the height changes programmatically. | +| HeightChanged( OldHeight as [[http://​developer.xojo.com/​integer|Integer]] ) | If AdaptiveHeight is True, this will fire when the height changes programmatically. | 
-| SearchFailed( SearchText as String ) | Raised when the search for the user-supplied string fails. |+| SearchFailed( SearchText as [[http://​developer.xojo.com/​string|String]] ) | Raised when the search for the user-supplied string fails. |
 | SelectionChanged() | Fires when an item is selected and displayed in the primary class UI. | | SelectionChanged() | Fires when an item is selected and displayed in the primary class UI. |
 | TagAdded( newTag as GraffitiTagFieldItem ) | Fires when a tag is added, so you can keep up with items that the user adds. | | TagAdded( newTag as GraffitiTagFieldItem ) | Fires when a tag is added, so you can keep up with items that the user adds. |
Line 16: Line 19:
 | TagRemoved( RemovedTag as GraffitiTagFieldItem ) | Raised when the user removes a tag. | | TagRemoved( RemovedTag as GraffitiTagFieldItem ) | Raised when the user removes a tag. |
  
-====== Methods ​======+==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| AddItem( newItem as GraffitiTagFieldItem,​ RefreshNow as Boolean = True ) | Used to add a tag to the Items() array. ​ RefreshNow should be false if you plan to add a large number of items at once (IE: during load). | +| AddItem( newItem as GraffitiTagFieldItem,​ RefreshNow as [[http://​developer.xojo.com/​boolean|Boolean]] = True ) | Used to add a tag to the Items() array. ​ RefreshNow should be false if you plan to add a large number of items at once (IE: during load). | 
-| FindItem( ItemText as String ) as Integer | Returns the index of the item with ItemText in the Items() array. | +| FindItem( ItemText as [[http://​developer.xojo.com/​string|String]] ) as [[http://​developer.xojo.com/​integer|Integer]] | Returns the index of the item with ItemText in the Items() array. | 
-| RemoveItem( ItemIndex as Integer ) | Removes item at ItemIndex from Items(). |+| RemoveItem( ItemIndex as [[http://​developer.xojo.com/​integer|Integer]] ) | Removes item at ItemIndex from Items(). |
 | SetSearchField( mySearchField as TextField ) | As part of the initial setup, binds the GraffitiWebTagField canvas to a TextField. | | SetSearchField( mySearchField as TextField ) | As part of the initial setup, binds the GraffitiWebTagField canvas to a TextField. |
  
-====== Properties ​======+==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| AdaptiveHeight | Boolean | False | If true, the control will automatically resize vertically as the user adds more and more tags. | +| AdaptiveHeight ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If true, the control will automatically resize vertically as the user adds more and more tags. | 
-| BackColor | Color | &​cFFFFFF | The background color of the field and canvas. | +| BackColor ​| [[http://​developer.xojo.com/​color|Color]] | &​cFFFFFF | The background color of the field and canvas. | 
-| BorderColor | Color | &​cCCCCCC | The border color of the canvas. | +| BorderColor ​| [[http://​developer.xojo.com/​color|Color]] | &​cCCCCCC | The border color of the canvas. | 
-| BorderRadius | Integer | 0 | The radius of the border corners. | +| BorderRadius ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The radius of the border corners. | 
-| CloseIconColor | Color | &​cDDDDDD44 | The color used to draw the close icon for the tags in the canvas. | +| CloseIconColor ​| [[http://​developer.xojo.com/​color|Color]] | &​cDDDDDD44 | The color used to draw the close icon for the tags in the canvas. | 
-| ExactMatchesOnly | Boolean | False | If True, searches will only show those items that exactly match the search string. | +| ExactMatchesOnly ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If True, searches will only show those items that exactly match the search string. | 
-| ItemBorderRadius | Integer | 0 | The border radius for tags in the canvas. |+| ItemBorderRadius ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The border radius for tags in the canvas. |
 | Items() | GraffitiTagFieldItem | Nil | The array of GraffitiTagFieldItems that the class uses. | | Items() | GraffitiTagFieldItem | Nil | The array of GraffitiTagFieldItems that the class uses. |
-| ItemBackColor | Color | False | The color used for the list. | +| ItemBackColor ​| [[http://​developer.xojo.com/​color|Color]] | False | The color used for the list. | 
-| ItemBorderColor | Color | False | The border color. | +| ItemBorderColor ​| [[http://​developer.xojo.com/​color|Color]] | False | The border color. | 
-| ItemTextBold | Boolean | False | Determines whether tags drawn in the canvas have bold text. | +| ItemTextBold ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether tags drawn in the canvas have bold text. | 
-| ItemTextColor | Color | False | The text color. | +| ItemTextColor ​| [[http://​developer.xojo.com/​color|Color]] | False | The text color. | 
-| ItemTextFont | String | "​System"​ | The font face used for tags. | +| ItemTextFont ​| [[http://​developer.xojo.com/​string|String]] | "​System"​ | The font face used for tags. | 
-| ItemTextItalic | Boolean | False | Determines whether tags drawn in the canvas have italic text. | +| ItemTextItalic ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether tags drawn in the canvas have italic text. | 
-| ItemTextSize | Integer | 0 | Sets the text size of tags drawn in the canvas. | +| ItemTextSize ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Sets the text size of tags drawn in the canvas. | 
-| ItemTextUnderline | Boolean | False | Determines whether tags drawn in the canvas have underlined text. | +| ItemTextUnderline ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether tags drawn in the canvas have underlined text. | 
-| MinimumHeight | Integer | 25 | The MinimumHeight is used to keep the TagField from reducing its height so far that it becomes unusable. |+| MinimumHeight ​| [[http://​developer.xojo.com/​integer|Integer]] | 25 | The MinimumHeight is used to keep the TagField from reducing its height so far that it becomes unusable. |
 | SearchField | TextField | Nil | The TextField that the TagField canvas is bound to. | | SearchField | TextField | Nil | The TextField that the TagField canvas is bound to. |
-| SearchThreshold | Integer | 1 | The number of characters before a search operation is carried out. |+| SearchThreshold ​| [[http://​developer.xojo.com/​integer|Integer]] | 1 | The number of characters before a search operation is carried out. |
  
-====== Examples ​======+==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.