Creating a Property - Revision history

MartinW at 08:22, 6 October 2023

2023-10-06T08:22:22Z

← Older revision		Revision as of 08:22, 6 October 2023
Line 3:		Line 3:
	When creating a program or a component you may wish to add your own properties to allow you to either simply switch some code in or out of the program or to control a specific feature within your code.		When creating a program or a component you may wish to add your own properties to allow you to either simply switch some code in or out of the program or to control a specific feature within your code.

	Properties can only be added to the root so to begin you must either click on an empty area of the [[~~Dashboard Panel~~\|~~Dasboard~~]] or [[~~System Panel~~]], or select the 'Panel' from the drop down menu at the top of the Properties Panel.~~[[File:Gen_Properties_Panel_Properties_Menu.jpg\|right]]~~		Properties can only be added to the root so to begin you must either click on an empty area of the [[[2d_Panels\|2D panels]] or [[System_Panel\|3D system panel]], or select the 'Panel' from the drop-down menu at the top of the Properties Panel.

			Clicking the drop-down menu next to 'Properties' on the panel properties window will bring up the menu shown below.

	~~Clicking the drop down menu next to 'Properties' on the panel properties window will bring up the menu shown above~~.		[[File:Gen_Properties_Panel_Properties_Menu.jpg]]

	The 'Add new' option allows a property to be created and pops up the dialogue window below.		The 'Add new' option allows a property to be created and pops up the dialogue window below.
Line 12:		Line 13:

	==Creating Properties==		==Creating Properties==
	[[File:Gen Create Panel Property 01.jpg~~\|right\|frameless~~]]
			[[File:Gen Create Panel Property 01.jpg]]

	The 'Cosmetic name' is the name label that is shown to the user by the side of the property.		The 'Cosmetic name' is the name label that is shown to the user by the side of the property.

Line 21:		Line 24:
	The 'Visible' check box decides if the property is displayed and available for the user to see and the 'Writable' check box decides if the property can be changed or configured by the user. Note that a property cannot be moved or edited if either of these check boxes are ticked.		The 'Visible' check box decides if the property is displayed and available for the user to see and the 'Writable' check box decides if the property can be changed or configured by the user. Note that a property cannot be moved or edited if either of these check boxes are ticked.

			==Property Type==

			[[File:Gen Panel Property Type 01.jpg]]












	~~==Property Type==~~
	~~[[File:Gen Panel Property Type 01.jpg\|right]]~~
	Here is a list of different property types that can be added and the data that they represent:		Here is a list of different property types that can be added and the data that they represent:
	:Panel Object - Create a list of all the current items on the panel, allowing you to select one. Component GUID filter can use GUID or name e.g. "937\|*GdiSwitch"		:Panel Object - Create a list of all the current items on the panel, allowing you to select one. Component GUID filter can use GUID or name e.g. "937\|*GdiSwitch"
	:*~~Color~~ Picker - Creates a ~~color~~ wheel allowing you to select a specific ~~color~~.		:*Colour Picker - Creates a colour wheel allowing you to select a specific colour.
	:*~~Color~~ Picker With Transparency - Creates a ~~color~~ wheel with transparency allowing you to select a specific ~~color~~.		:*Colour Picker With Transparency - Creates a colour wheel with transparency allowing you to select a specific colour.
	:*Font Picker - Creates a list of installed Fonts.		:*Font Picker - Creates a list of installed Fonts.
	:*Entire Digital Port - Creates a list of full ports for the current target device.		:*Entire Digital Port - Creates a list of full ports for the current target device.
Line 70:		Line 62:

	==Managing Properties==		==Managing Properties==
	[[File:Gen Create Panel Property Catagory 01.jpg~~\|right\|frameless~~]]
			[[File:Gen Create Panel Property Catagory 01.jpg]]

	The property can be edited by right clicking on the property and selecting 'Edit' from the context / drop down menu.		The property can be edited by right clicking on the property and selecting 'Edit' from the context / drop down menu.

Line 76:		Line 70:


	The layout of any properties and categories you have added can be altered by simply left clicking and dragging the specific item up and down on the Properties Panel ~~window.~~		The layout of any properties and categories you have added can be altered by simply left clicking and dragging the specific item up and down on the Properties Panel windo













Line 94:		Line 77:

	View the [http://www.youtube.com/watch?v=k-J6pCYkEk0&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ&index=33 Component Properties] video for information on how to create and use custom panel properties effectively as well as the differences between the different type of properties available.		View the [http://www.youtube.com/watch?v=k-J6pCYkEk0&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ&index=33 Component Properties] video for information on how to create and use custom panel properties effectively as well as the differences between the different type of properties available.

	~~<div align="center">~~
	~~{{#ev:youtube\|k-J6pCYkEk0\|640}}~~
	~~</div>~~

	~~<div align="center">~~
	~~{{#ev:youtube\|xhvrwILJA38\|640}}~~
	~~</div>~~

	~~<div align="center">~~
	~~{{#ev:youtube\|RWZcctFtMyU\|640}}~~
	~~</div>~~

BenR: /* Property Type */

2023-02-07T13:29:42Z

Property Type

BenR: /* Property Type */

2023-02-07T13:25:00Z

Property Type

← Older revision		Revision as of 13:25, 7 February 2023
Line 59:		Line 59:
	:*General Expression - Creates a text field allowing an sum or expression to be entered.		:*General Expression - Creates a text field allowing an sum or expression to be entered.
	:*Fixed List of Expressions - Creates a user selectable list of expressions each with a unique three digit integer number.		:*Fixed List of Expressions - Creates a user selectable list of expressions each with a unique three digit integer number.
			:*Macro Call - A macro from the users project to call, often used for things like call back events.
			:*Brush - a colour picker with two pickers used for defining foreground and background colours in a single property.

	==Property Tooltips==		==Property Tooltips==

DavidA at 08:39, 2 July 2019

2019-07-02T08:39:47Z

← Older revision		Revision as of 08:39, 2 July 2019
Line 1:		Line 1:
	~~<sidebar>Sidebar: Flowcode Help Overview:ComponentCreation</sidebar>~~

	When a component on the panel is selected the [[Properties Panel]] window will be populated with properties associated with that component to allow you to configure the component to your requirements.		When a component on the panel is selected the [[Properties Panel]] window will be populated with properties associated with that component to allow you to configure the component to your requirements.

BenR at 10:04, 25 July 2018

2018-07-25T10:04:13Z

← Older revision		Revision as of 10:04, 25 July 2018
Line 61:		Line 61:
	:*General Expression - Creates a text field allowing an sum or expression to be entered.		:*General Expression - Creates a text field allowing an sum or expression to be entered.
	:*Fixed List of Expressions - Creates a user selectable list of expressions each with a unique three digit integer number.		:*Fixed List of Expressions - Creates a user selectable list of expressions each with a unique three digit integer number.


			==Property Tooltips==

			Tooltips can be added to properties to provide the user an explanation of what the property will be used for.

			The tooltip text can be accessed by clicking the drop down arrow to the right of the Cosmetic Name in the Edit Properties window.

BenR: /* Video instructions */

2014-10-14T09:26:31Z

Video instructions

← Older revision		Revision as of 09:26, 14 October 2014
Line 95:		Line 95:
	<div align="center">		<div align="center">
	{{#ev:youtube\|xhvrwILJA38\|640}}		{{#ev:youtube\|xhvrwILJA38\|640}}
			</div>

			<div align="center">
			{{#ev:youtube\|RWZcctFtMyU\|640}}
	</div>		</div>

BenR: /* Video instructions */

2014-10-14T09:25:59Z

Video instructions

← Older revision		Revision as of 09:25, 14 October 2014
Line 94:		Line 94:

	<div align="center">		<div align="center">
	{{#ev:youtube\|xhvrwILJA38~~&index=3&list=PLCZaPFyK6UlLyg-a8Fm01ZWFvp-GxBLgc~~\|640}}		{{#ev:youtube\|xhvrwILJA38\|640}}
	</div>		</div>

BenR: /* Video instructions */

2014-10-14T09:25:43Z

Video instructions

← Older revision		Revision as of 09:25, 14 October 2014
Line 91:		Line 91:
	<div align="center">		<div align="center">
	{{#ev:youtube\|k-J6pCYkEk0\|640}}		{{#ev:youtube\|k-J6pCYkEk0\|640}}
			</div>

			<div align="center">
			{{#ev:youtube\|xhvrwILJA38&index=3&list=PLCZaPFyK6UlLyg-a8Fm01ZWFvp-GxBLgc\|640}}
	</div>		</div>

BenR at 16:59, 7 March 2014

2014-03-07T16:59:28Z

← Older revision		Revision as of 16:59, 7 March 2014
Line 1:		Line 1:
			<sidebar>Sidebar: Flowcode Help Overview:ComponentCreation</sidebar>

	When a component on the panel is selected the [[Properties Panel]] window will be populated with properties associated with that component to allow you to configure the component to your requirements.		When a component on the panel is selected the [[Properties Panel]] window will be populated with properties associated with that component to allow you to configure the component to your requirements.

ReeceL at 15:16, 4 September 2013

2013-09-04T15:16:37Z

← Older revision		Revision as of 15:16, 4 September 2013
Line 20:		Line 20:

	The 'Visible' check box decides if the property is displayed and available for the user to see and the 'Writable' check box decides if the property can be changed or configured by the user. Note that a property cannot be moved or edited if either of these check boxes are ticked.		The 'Visible' check box decides if the property is displayed and available for the user to see and the 'Writable' check box decides if the property can be changed or configured by the user. Note that a property cannot be moved or edited if either of these check boxes are ticked.

← Older revision		Revision as of 13:29, 7 February 2023
Line 37:		Line 37:
	[[File:Gen Panel Property Type 01.jpg\|right]]		[[File:Gen Panel Property Type 01.jpg\|right]]
	Here is a list of different property types that can be added and the data that they represent:		Here is a list of different property types that can be added and the data that they represent:
	:*Panel Object - Create a list of all the current items on the panel, allowing you to select one.		:Panel Object - Create a list of all the current items on the panel, allowing you to select one. Component GUID filter can use GUID or name e.g. "937\|*GdiSwitch"
	:*Color Picker - Creates a color wheel allowing you to select a specific color.		:*Color Picker - Creates a color wheel allowing you to select a specific color.
	:*Color Picker With Transparency - Creates a color wheel with transparency allowing you to select a specific color.		:*Color Picker With Transparency - Creates a color wheel with transparency allowing you to select a specific color.
Line 48:		Line 48:
	:*Signed Integer - Creates a text field allowing positive and negative integer numbers.		:*Signed Integer - Creates a text field allowing positive and negative integer numbers.
	:*Unsigned Integer - Creates a text field allowing only positive integer numbers.		:*Unsigned Integer - Creates a text field allowing only positive integer numbers.
	:*Bit Mask - Creates a bit mask with check boxes to set or clear the bits in the mask.		:*Bit Mask - Creates a bit mask with check boxes to set or clear the bits in the mask. Size of bitmask sets the number of bits range 2-32.
	:*Fixed List of Ints - Creates a user selectable list of values each with a unique three digit integer number.		:*Fixed List of Ints - Creates a user selectable list of values each with a unique three digit integer number.
	:*Floating Point - Creates a text field allowing positive and negative real numbers.		:*Floating Point - Creates a text field allowing positive and negative real numbers.
Line 55:		Line 55:
	:*Multiple Lines Of Text - Creates a text field allowing multiple lines of text to be entered.		:*Multiple Lines Of Text - Creates a text field allowing multiple lines of text to be entered.
	:*Fixed List of Text - Creates a user selectable list of values each with a unique three character reference.		:*Fixed List of Text - Creates a user selectable list of values each with a unique three character reference.
	:*Filename - Creates a text field with a browse button to allow you to select a file.		:Filename - Creates a text field with a browse button to allow you to select a file. Example file filter - "Text (.txt)\|.txt\|CSV (.csv)\|*.csv"
	:*Directory - Creates a text field with a browse button to allow you to select a directory.		:*Directory - Creates a text field with a browse button to allow you to select a directory.
	:*General Expression - Creates a text field allowing an sum or expression to be entered.		:*General Expression - Creates a text field allowing an sum or expression to be entered.