Skip to content

Commit 3c82909

Browse files
sjackson-etharsjackson-ethar
committed
Updated combobox controls and fixed relative links in controls
1 parent 80967cf commit 3c82909

41 files changed

Lines changed: 150 additions & 132 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Controls/AutoCompleteComboBox.md‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,27 @@ A specialised text field that allows a vocabulary to be added to guide or restri
3636

3737
## Properties
3838

39-
The properties of the Box Slider control are as follows:
39+
The properties of the AutoComplete Combobox control are as follows:
4040

4141
Property | Description
4242
|-|-|
43-
*Disabled Text Color*|Color of the Autocomplete field when the control is disabled
44-
*Available Options*|Array of text based options for the dropdown/selection
45-
*Scroll Bar Width*|The width of the scrollbar when displayed
43+
*Available Options*|Array of text based options for the dropdown/selection.
44+
*Is Active*|Can the autocomplete combo box be activated by the user (dropped down) or is it disabled?
45+
*Scroll Bar Width*|The width of the scrollbar when displayed.
4646
*Items To Display*|Number of child items to display when opened. *Note default 0 shows NO items.
47-
*Select First Item On Start*|Should the first item be auto selected on start
48-
*Change Input Text based on Matching items*|Apply the below colors to the AutoComplete field based on user typing
49-
*Dropdown Offset*|Offset height for the drop down window, to give enough space for items
50-
*Valid Selection Text Color*|Color of the AutoComplete text if the full text appears in the list of options
51-
*Matching Items Remaining Text Color*|Intermediate color of text when options contain the text entered
52-
*No Items Remaining Text Color*|Text Color when the text entered does not match anything in the list
53-
*Autocomplete Search Type)|Selects the search method for which to validate the panel items. Values Linq, Array Sort. Choose whichever performs best for your project.
54-
*On Selection Text Changed* (event) |The Event fired when the the user is typing
55-
*On Selection Validity Changed* (event) |The Event fired when the the text the user enters matches a selection
56-
*On Selection Changed* (event) |The Event fired when the user selects an option or loses focus
47+
*Change Input Text based on Matching items*|Apply the below colors to the AutoComplete field based on user typing.
48+
*Valid Selection Text Color*|Color of the AutoComplete text if the full text appears in the list of options.
49+
*Matching Items Remaining Text Color*|Intermediate color of text when options contain the text entered.
50+
*No Items Remaining Text Color*|Text Color when the text entered does not match anything in the list.
51+
*Autocomplete Search Type*|Selects the search method for which to validate the panel items. Values Linq, Array Sort. Choose whichever performs best for your project.
52+
*Dropdown Offset*|Offset height for the drop down window, to give enough space for items.
53+
*Display Panel Above*|Should the dropdown panel appear above the control instead of below?
54+
*Select First Item On Start*|Should the first item be auto selected on start?
55+
*Select Index Item on Start*|Which item should be selected on start. (*Select First Item on Start* will override this option)
56+
*On Selection Text Changed* (event) |The Event fired when the the user is typing.
57+
*On Selection Validity Changed* (event) |The Event fired when the the text the user enters matches a selection.
58+
*On Selection Changed* (event) |The Event fired when the user selects an option or loses focus.
59+
*On Control Disabled* (event) |The Event fired when the control is disabled through code.
5760

5861
> When managing the control programmatically, make sure you use the following functions to manage the ComboBox contents. **Do NOT update the 'AvailableOptions' list directly**
5962
@@ -63,11 +66,12 @@ Property | Description
6366

6467
Method | Arguments | Description
6568
|-|-|-|
66-
AddItem|String|Adds a single item to the list
67-
RemoveItem|String|Removes a single item from the list
68-
SetAvailableOptions|List of String|Clears the current options and replaces with new list (array or List)
69-
SetAvailableOptions|Array of String|Clears the current options and replaces with new list (array or List)
70-
ResetItems|None|Clears all current options
69+
*AddItem*|String|Adds a single item to the list
70+
*RemoveItem*|String|Removes a single item from the list
71+
*SelectItemIndex*|int|Sets the currently selected item in the list
72+
*SetAvailableOptions*|List of String|Clears the current options and replaces with new list (array or List)
73+
*SetAvailableOptions*|Array of String|Clears the current options and replaces with new list (array or List)
74+
*ResetItems*|N/A|Clears all current options
7175

7276
---------
7377

@@ -86,8 +90,8 @@ GameObject -> UI -> Extensions -> AutoCompleteComboBox
8690

8791
## See also
8892

89-
[ComboBox](/Controls.md/ComboBox)
90-
[DropDownList](/Controls.md/DropDownList)
93+
[ComboBox](/Controls/ComboBox.md)
94+
[DropDownList](/Controls/DropDownList.md)
9195

9296
---------
9397

‎Controls/BestFitOutline.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ tbc
4747

4848
## See also
4949

50-
[NicerOutline](/Controls.md/NicerOutline)
50+
[NicerOutline](/Controls/NicerOutline.md)
5151

5252
---------
5353

‎Controls/BoundToolTip.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ UI -> Extensions -> Bound Tooltip -> Tooltip Trigger
5252

5353
## See also
5454

55-
[ToolTip](/Controls.md/ToolTip)
56-
[HoverToolTip](/Controls.md/HoverToolTip)
55+
[ToolTip](/Controls/ToolTip.md)
56+
[HoverToolTip](/Controls/HoverToolTip.md)
5757

5858
---------
5959

‎Controls/ComboBox.md‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,34 @@ Similar to the new built in Unity Dropdown control
3737

3838
## Properties
3939

40-
The properties of the Box Slider control are as follows:
40+
The properties of the Combo Box control are as follows:
4141

4242
Property | Description
4343
|-|-|
4444
*Available Options*|Array of text based options for the dropdown/selection
45+
*Is Active*|Can the autocomplete combo box be activated by the user (dropped down) or is it disabled?
4546
*Scroll Bar Width*|The width of the scrollbar when displayed
4647
*Items To Display*|Number of child items to display when opened. *Note default 0 shows NO items.
48+
*Dropdown Offset*|Offset height for where the dropdown list should appear.
49+
*Display Panel Above*|Should the dropdown panel appear above the control instead of below?
4750
*Sort Items*|Should the items in the combo box be sorted
51+
*Select First Item On Start*|Should the first item be auto selected on start
52+
*Select Index Item on Start*|Which item should be selected on start (*Select First Item on Start* will override this option)
4853
*On Selection Changed* (event) |The Event fired when the user selects an option or loses focus
54+
*On Control Disabled* (event) |The Event fired when the control is disabled through code.
4955

5056
---------
5157

5258
## Methods
5359

5460
Method | Arguments | Description
5561
|-|-|-|
56-
AddItem|String|Adds a single item to the list
57-
RemoveItem|String|Removes a single item from the list
58-
SetAvailableOptions|List of String|Clears the current options and replaces with new list (array or List)
59-
SetAvailableOptions|Array of String|Clears the current options and replaces with new list (array or List)
60-
ResetItems|None|Clears all current options
62+
*AddItem*|String|Adds a single item to the list
63+
*RemoveItem*|String|Removes a single item from the list
64+
*SelectItemIndex*|int|Sets the currently selected item in the list
65+
*SetAvailableOptions*|List of String|Clears the current options and replaces with new list (array or List)
66+
*SetAvailableOptions*|Array of String|Clears the current options and replaces with new list (array or List)
67+
*ResetItems*|N/A|Clears all current options
6168

6269
---------
6370

@@ -78,8 +85,8 @@ Then simply add child elements to the Items property.
7885

7986
## See also
8087

81-
[DropDownList](/Controls.md/DropDownList)
82-
[AutoCompleteComboBox](/Controls.md/AutoCompleteComboBox)
88+
[DropDownList](/Controls/DropDownList.md)
89+
[AutoCompleteComboBox](/Controls/AutoCompleteComboBox.md)
8390

8491
---------
8592

‎Controls/ContentScrollSnapHorizontal.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ This will give you a standard Scroll Rect setup with the script and a few exampl
9696

9797
## See also
9898

99-
* [HorizontalScrollSnap](/Controls.md/HorizontalScrollSnap)
100-
* [VerticalScrollSnap](/Controls.md/VerticalScrollSnap)
101-
* [ScrollSnap](/Controls.md/ScrollSnap)
99+
* [HorizontalScrollSnap](/Controls/HorizontalScrollSnap.md)
100+
* [VerticalScrollSnap](/Controls/VerticalScrollSnap.md)
101+
* [ScrollSnap](/Controls/ScrollSnap.md)
102102

103103
---------
104104

‎Controls/CooldownButton.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ The CooldownButton control is available as a Game Component menu in "*UI / Exten
8181
## See also
8282

8383
* Unity Button (built-in)
84-
* [Non Drawing Graphic](/Controls.md/NonDrawingGraphic)
85-
* [Selectable Extension](/Controls.md/UISelectableExtension)
84+
* [Non Drawing Graphic](/Controls/NonDrawingGraphic.md)
85+
* [Selectable Extension](/Controls/UISelectableExtension.md)
8686

8787
---------
8888

‎Controls/CurlyUI.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ Once added, you can then manipulate the curves for the RectTransform using the b
8181

8282
## See also
8383

84-
* [Curved Text](/Controls.md/CurvedText)
85-
* [Cylinder Text](/Controls.md/CylinderText)
86-
* [Curved Layout](/Controls.md/CurvedLayout)
84+
* [Curved Text](/Controls/CurvedText.md)
85+
* [Cylinder Text](/Controls/CylinderText.md)
86+
* [Curved Layout](/Controls/CurvedLayout.md)
8787

8888
---------
8989

‎Controls/CurvedLayout.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ tbc
5757

5858
## See also
5959

60-
* [Radial Layout Group](/Controls.md/RadialLayout)
61-
* [Table Layout Group](/Controls.md/TableLayoutGroup)
62-
* [Flow Layout Group](/Controls.md/FlowLayoutGroup)
60+
* [Radial Layout Group](/Controls/RadialLayout.md)
61+
* [Table Layout Group](/Controls/TableLayoutGroup.md)
62+
* [Flow Layout Group](/Controls/FlowLayoutGroup.md)
6363

6464
---------
6565

‎Controls/CylinderText.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Add Component -> UI -> Effects -> Extensions -> Cylinder Text
4747

4848
## See also
4949

50-
[CurvedText](/Controls.md/CurvedText)
50+
[CurvedText](/Controls/CurvedText.md)
5151

5252
---------
5353

‎Controls/DiamondGraph.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ GameObject -> UI -> Extensions -> Diamond Graph
4747

4848
## See also
4949

50-
[UIPolygon](/Controls.md/UIPolygon)
50+
[UIPolygon](/Controls/UIPolygon.md)
5151

5252
---------
5353

0 commit comments

Comments
 (0)