Difference between revisions of "Component: Input Text ( Control)"

Latest revision as of 08:59, 9 June 2025

Author	MatrixTSL
Version	1.0
Category	Control

Input Text component

Creates a text field that can be highlighted and edited by the user.

Version information

Library Version, Component Version, Date, Author, Info
3, 1.0, 14-02-25, ST, Changed generated CSS to ensure disabled control has grey text

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetFloat

	GetFloat
Returns the floating point numeric value entered into the text field
- FLOAT	Return

GetText

	GetText
Returns the text currently entered into this text field
- STRING	Return

GetValue

	GetValue
Returns the numeric value entered into the text field
- LONG	Return

SetFloat

	SetFloat
Sets the numeric floating point value displayed in this text field
- FLOAT	Value
float value to set
- VOID	Return

SetText

	SetText
Sets the text displayed in this text field
- STRING	sText
Text to set
- VOID	Return

SetValue

	SetValue
Sets the numeric value displayed in this text field
- LONG	Value
integer value to set
- VOID	Return

Property reference

	Properties
	Text
	Text
The initial text of the component
	Type
Allows the input to be restricted to numbers or hidden
	Limit Length
Sets a limit on how many characters can be entered
	Max Length
The maximum number of characters
	Style
	Font
Specifies the font style for the text
	Font Size
The font size in pixels
	Horizontal Alignment
Aligns the text entered
	Bold
Make the caption text bold
	Italic
Make the caption text italicised
	Underline
Make the caption text underlined
	Strikethrough
Make the caption text crossed-out
	Colour
	Text
Specifies the font colour for the item
	Background
Specifies the background colour value
	Advanced
	Custom Attributes
Text here will be added to the html tag of this component to allow advanced customisation

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WEBEXP_InputText.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_WEBEXP_InputText.fcsx

@@ Line 5: / Line 5: @@
 |-
 | width="20%" style="color:gray;" | Version
-| 0.1
+| 1.0
 |-
 | width="20%" style="color:gray;" | Category
@@ Line 15: / Line 15: @@
 Creates a text field that can be highlighted and edited by the user.
-==Component Source Code==
+==Version information==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]
+ Library Version, Component Version, Date, Author, Info
+, 1.0, 14-02-25, ST, Changed generated CSS to ensure disabled control has grey text
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]
 ==Detailed description==
@@ Line 28: / Line 29: @@
 ''<span style="color:red;">No additional examples</span>''
 ==Macro reference==
+===GetFloat===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
+|-
+| colspan="2" | Returns the floating point numeric value entered into the text field&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
 ===GetText===
@@ Line 37: / Line 54: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetText'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Returns the text currently entered into this text field&nbsp;
 |-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===GetValue===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
+|-
+| colspan="2" | Returns the numeric value entered into the text field&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===SetFloat===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFloat'''
+|-
+| colspan="2" | Sets the numeric floating point value displayed in this text field&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Value
+|-
+| colspan="2" | float value to set&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 51: / Line 101: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetText'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Sets the text displayed in this text field&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | s
+| width="90%" | sText
 |-
 | colspan="2" | Text to set&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===SetValue===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
+|-
+| colspan="2" | Sets the numeric value displayed in this text field&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Value
+|-
+| colspan="2" | integer value to set&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 79: / Line 148: @@
 | width="90%" | Text
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | The initial text of the component&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
 | width="90%" | Type
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Allows the input to be restricted to numbers or hidden&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Limit Length
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Sets a limit on how many characters can be entered&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 | width="90%" | Max Length
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | The maximum number of characters&nbsp;
 |-
 | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
@@ Line 103: / Line 172: @@
 | width="90%" | Font
 |-
-| colspan="2" | Specifies the font style for the item&nbsp;
+| colspan="2" | Specifies the font style for the text&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 | width="90%" | Font Size
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | Font size
 |-
 | colspan="2" | The font size in pixels&nbsp;
@@ Line 118: / Line 182: @@
 | width="90%" | Horizontal Alignment
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Aligns the text entered&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Bold
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Make the caption text bold&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Italic
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Make the caption text italicised&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Underline
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Make the caption text underlined&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Strikethrough
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Make the caption text crossed-out&nbsp;
 |-
 | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
@@ Line 161: / Line 225: @@
 | width="90%" | Custom Attributes
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation&nbsp;
 |}
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]

Difference between revisions of "Component: Input Text ( Control)"

Latest revision as of 08:59, 9 June 2025

Contents