TextFormatFrame

Assembles text from a list of tokens, and formats it according to specified pattern.

Class
CTextFormatFrame <— CFrame
Desc
- None -

Description

Utility frame - doesn’t display anything by itself. Its purpose is to assemble a text, from a list of tokens provided in Replacement list, using a pattern set in FormatText.

Assembled text is stored in a Text property (read-only). Which can be bound to property of another frame, such as Text in Label.

# Example

<Frame type="TextFormatFrame" name="ShieldsText">
    <Anchor relative="$parent"/>
    <FormatText val="%0% / %1%"/>
    <Replacement val="{$parent/HealthValues/@Shields}" index="0"/>
    <Replacement val="{$parent/HealthValues/@MaxShields}" index="1"/>
</Frame>
<Frame type="Label" name="FenixCurrentShields">
    <Text val="{$parent/ShieldsText/@Text}"/>
</Frame>

Properties

 

— CTextFormatFrame

(5)
Edit on Github
@ val  
[ Text ]

Pattern in which text should be formatted. i.e. %0% / %1%.

@ val  
[ Text ]
@ index ?
[ Uint8 ]

Name of tokens. If not set, token will be in form of a index/number, i.e. 0 for first element.

@ val  
[ Text ]
@ index ?
[ Uint8 ]

List of values for replacement.

@ val  
[ Uint32 ]

Number of replacements required for assembling the text, otherwise the Text property will be left blank.

@ val  
[ String ]

Resulting text.

 

— CFrame

(47)
Edit on Github
@ val  
[ Boolean ]
False | True

Determines if frame can receive mouse events.(see more)

@ val  
[ Boolean ]
False | True

Determines if frame can accept drag & drop events.(see more)

@ val  
[ Boolean ]
False | True
@ val  
[ Uint8 ]

Determines the transparency of the element, by adjusting its Alpha channel.(see more)

@ val  
[ Boolean ]
False | True
@ val  
[ Image ]
@ side ?
[ AnchorSide ]
Top | Left | Right | Bottom
@ relative  
[ FrameReference ]
@ pos ?
[ AnchorPos ]
@ offset ?
[ Int32 ]

Used to position a frame. A frame can have up to 4 anchors.(see more)

@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True

Enables verbose logging of animations defined inside this frame.

@ maxheight ?
[ Int32 ]
@ maxwidth ?
[ Int32 ]
@ minheight ?
[ Int32 ]
@ minwidth ?
[ Int32 ]
@ val ?
[ String ]
@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True

Enables blurring the frame and its children. The actual blur factor is determined by BlurAmount.

@ val  
[ Real32 ]

The amount a frame will be blurred. Blur need to be set as True for this feature to work.

@ val  
[ EImageShaderBlendMode ]
Multiply | Add | Alpha | Subtract | Normal | Lighten | Darken

The blending mode used for BlurShader.

@ val  
[ Boolean ]
False | True

Works in conjunction with PreserveAnchorOffset. Generally when a frame is collapsed, other frames anchoring to it will ignore their offsets and will be placed right at the Left and Top anchor of the collpased frame. With PreserveAnchorOffset, anchoring items will preserve their offset.

@ val  
[ Color ]
@ val  
[ ContextMenu ]
@ val  
[ MouseButtons ]
Left | Middle | Right | XButton1 | XButton2 | Shift | Control | Alt | TopToTop | TopToBottom | BottomToTop | BottomToBottom | VCenterToCenter | LeftToLeft | LeftToRight | RightToLeft | RightToRight | HCenterToCenter | TopLeft | TopCenter | TopRight | MiddleLeft | MiddleRight | BottomLeft | BottomCenter | BottomRight
@ val  
[ Boolean ]
False | True
@ val  
[ Uint8 ]

Alpha value when frame is in disabled state

@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True

Enables / disables frame. It might have different results that will vary basing on the type of the frame.(see more)

@ val  
[ Handle ]

Unique global identifier. Allows referencing the frame from any place within hierarchy, by using defined handle prefixed with $, i.e. $MyHandle.(see more)

@ val  
[ Real32 ]

Height of the frame(see more)

@ val  
[ Image ]
@ alias  
[ FrameReference ]
@ original  
[ String ]

Allows to define an alias that can be used for redirecting the hookup action, which is used to retrieve named FrameDesc within the current frame.(see more)

@ val  
[ Boolean ]
False | True

Allows a child element to ignore the Alpha settings of its parent

@ val  
[ Boolean ]
False | True

Allows a child element to ignore the color settings of its parent

@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True

Works in conjunction with CollapseLayout. Generally when a frame its collapsed, other frames anchoring to it will ignore their offsets and be placed right at the Left and Top anchor of the collpased frame. With this property, anchoring items will preserve their offset.

@ val  
[ Uint16 ]

Render priority of the element (512 is default value). Frames with higher priority will render on top of others.(see more)

@ val  
[ ERenderType ]
RTT | HDR | Offscreen | LDR

Render type of the element(see more)

@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True
@ val  
[ Text ]
@ val  
[ TooltipAnchorPosition ]
TopToTop | TopToBottom | BottomToTop | BottomToBottom | VCenterToCenter | LeftToLeft | LeftToRight | RightToLeft | RightToRight | HCenterToCenter | TopLeft | TopCenter | TopRight | MiddleLeft | MiddleRight | BottomLeft | BottomCenter | BottomRight
@ val  
[ Boolean ]
False | True
@ val  
[ Tooltip ]
@ val  
[ Boolean ]
False | True

Allows a frame to be rendered outside its parent countainer bounds.(see more)

@ val  
[ Boolean ]
False | True

Specifies which kind of time should be used for animations of this frame.(see more)

@ val  
[ Boolean ]
False | True
@ val  
[ Boolean ]
False | True

Determines whether animations that use Fade controller will toggle Visibility state of the frame, once they’re finished.

@ val  
[ Boolean ]
False | True

Determines visibility of the frame.

@ val  
[ Real32 ]

Width of the frame(see more)