Component: Component Label (Misc)

From Flowcode Help
Jump to navigationJump to search
Author Matrix Ltd.
Version 1.2
Category Misc


Component Label component

Add a label to a component by including this component as a sub-component. The label will always face the viewer and move with its parent object. Text for the label is automatically read from the host component's name or any chosen property.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_component_label.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_component_label.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

Hide

Fc9-comp-macro.png Hide
Hides the label. 
Fc9-void-icon.png - VOID Return


SetColor

Fc9-comp-macro.png SetColor
Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions. 
Fc9-u32-icon.png - ULONG Color
Color to set the labels to. 
Fc9-void-icon.png - VOID Return


SetColorRGB

Fc9-comp-macro.png SetColorRGB
Set the label color using separate red, green and blue color channels. 
Fc9-u8-icon.png - BYTE Red
Color parameter 
Fc9-u8-icon.png - BYTE Green
Color parameter 
Fc9-u8-icon.png - BYTE Blue
Color parameter 
Fc9-void-icon.png - VOID Return


SetPosition

Fc9-comp-macro.png SetPosition
Set where the label will appear relative to the object. 
Fc9-u8-icon.png - BYTE Position
Set the position - choose a preset from the list of constants, or 'Position XYZ to enter values below. 
Fc9-f32-icon.png - FLOAT X
X axis offset (only if 'Position_XYZ' selected for 'Position') 
Fc9-f32-icon.png - FLOAT Y
Y axis offset (only if 'Position_XYZ' selected for 'Position') 
Fc9-f32-icon.png - FLOAT Z
Z axis offset (only if 'Position_XYZ' selected for 'Position') 
Fc9-void-icon.png - VOID Return


SetTargets

Fc9-comp-macro.png SetTargets
Set the objects used to determine the label text and position. 
Fc9-h32-icon.png - HANDLE TextObject
Object that will provide the label text from its name or a property. 
Fc9-h32-icon.png - HANDLE BoundsObject
Object that will set the label position and bounding box. 
Fc9-void-icon.png - VOID Return


ShowName

Fc9-comp-macro.png ShowName
Sets the label to show the target object's name 
Fc9-void-icon.png - VOID Return


ShowProperty

Fc9-comp-macro.png ShowProperty
Sets the label to show a named property of the target object. 
Fc9-string-icon.png - STRING Property
Name of the property to show. 
Fc9-void-icon.png - VOID Return


Update

Fc9-comp-macro.png Update
Refresh the label after a change. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Show
Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) 
Fc9-type-17-icon.png Label target
Set the object from which the label text will be taken. If none is given, defaults to the parent of the label component. 
Fc9-type-17-icon.png Bounds target
Set the object used to set the dimensions used for the positioning of the labels. If none is given, defaults to the parent of the label component. 
Fc9-type-7-icon.png Auto Update
Automatically update the label whenever the target's name or labelled property changes. Use this sparingly, as it requires the component to regularly poll the component for changes!! 
Fc9-conn-icon.png Appearance
Fc9-type-1-icon.png Color
Color of the label text. 
Fc9-type-2-icon.png Background
Color for label backgroiunds - may be transparent. 
Fc9-type-7-icon.png Always On Top
Whether labels should always be draw on top of other objects. 
Fc9-conn-icon.png Size
Fc9-type-15-icon.png Scale
Sets the basic size (text height) of the labels. 
Fc9-type-7-icon.png Follow Zoom
Whether labels get bigger and smaller when the panel is zoomed in and out. 
Fc9-conn-icon.png Offset
Fc9-type-16-icon.png Auto
Attempt to automatically move the label to the side of the object. Choose a positive or negative offset in any of the three axes. When 'off', the manual offsett values can be edited below.