Show / Hide Table of Contents

Class TextBlock

A simple static text widget.

Inheritance
System.Object
UObject
Visual
Widget
TextLayoutWidget
TextBlock
Inherited Members
TextLayoutWidget.ShapedTextOptions
TextLayoutWidget.Justification
TextLayoutWidget.AutoWrapText
TextLayoutWidget.WrapTextAt
TextLayoutWidget.Margin
TextLayoutWidget.LineHeightPercentage
Widget.ForceLayoutPrepass()
Widget.ForceVolatile(Boolean)
Widget.GetCachedGeometry(Geometry)
Widget.GetClipping()
Widget.GetDesiredSize()
Widget.GetIsEnabled()
Widget.GetOwningLocalPlayer()
Widget.GetOwningPlayer()
Widget.GetParent()
Widget.GetRenderOpacity()
Widget.GetVisibility()
Widget.HasAnyUserFocus()
Widget.HasFocusedDescendants()
Widget.HasKeyboardFocus()
Widget.HasMouseCapture()
Widget.HasMouseCaptureByUser(Int32, Int32)
Widget.HasUserFocus(PlayerController)
Widget.HasUserFocusedDescendants(PlayerController)
Widget.InvalidateLayoutAndVolatility()
Widget.IsHovered()
Widget.IsVisible()
Widget.RemoveFromParent()
Widget.ResetCursor()
Widget.SetAllNavigationRules(EUINavigationRule, Name)
Widget.SetClipping(EWidgetClipping)
Widget.SetCursor(Byte)
Widget.SetIsEnabled(Boolean)
Widget.SetKeyboardFocus()
Widget.SetNavigationRule(EUINavigation, EUINavigationRule, Name)
Widget.SetRenderAngle(Single)
Widget.SetRenderOpacity(Single)
Widget.SetRenderScale(Vector2D)
Widget.SetRenderShear(Vector2D)
Widget.SetRenderTransform(WidgetTransform)
Widget.SetRenderTransformPivot(Vector2D)
Widget.SetRenderTranslation(Vector2D)
Widget.SetToolTip(Widget)
Widget.SetToolTipText(Byte)
Widget.SetUserFocus(PlayerController)
Widget.SetVisibility(ESlateVisibility)
Widget.Slot
Widget.ToolTipWidget
Widget.RenderTransform
Widget.RenderTransformPivot
Widget.bIsVariable
Widget.bCreatedByConstructionScript
Widget.bIsEnabled
Widget.bOverride_Cursor
Widget.bIsVolatile
Widget.bHiddenInDesigner
Widget.bExpandedInDesigner
Widget.bLockedInDesigner
Widget.Cursor
Widget.RenderOpacity
Widget.Navigation
Widget.NativeBindings
Widget.DesignerFlags
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class TextBlock : TextLayoutWidget
Remarks
  • No Children
  • Text

Properties

| Improve this Doc View Source

bWrapWithInvalidationPanel

Declaration
public bool bWrapWithInvalidationPanel { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ColorAndOpacity

The color of the text

Declaration
public SlateColor ColorAndOpacity { get; }
Property Value
Type Description
SlateColor
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static TextBlock DefaultObject { get; }
Property Value
Type Description
TextBlock
| Improve this Doc View Source

Font

The font to render the text with

Declaration
public SlateFontInfo Font { get; }
Property Value
Type Description
SlateFontInfo
| Improve this Doc View Source

MinDesiredWidth

The minimum desired size for the text

Declaration
public float MinDesiredWidth { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ShadowColorAndOpacity

The color of the shadow

Declaration
public LinearColor ShadowColorAndOpacity { get; }
Property Value
Type Description
LinearColor
| Improve this Doc View Source

ShadowOffset

The direction the shadow is cast

Declaration
public Vector2D ShadowOffset { get; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GetDynamicFontMaterial()

Get Dynamic Font Material

Declaration
public MaterialInstanceDynamic GetDynamicFontMaterial()
Returns
Type Description
MaterialInstanceDynamic
| Improve this Doc View Source

GetDynamicOutlineMaterial()

Get Dynamic Outline Material

Declaration
public MaterialInstanceDynamic GetDynamicOutlineMaterial()
Returns
Type Description
MaterialInstanceDynamic
| Improve this Doc View Source

GetText()

Gets the widget text @

Declaration
public byte GetText()
Returns
Type Description
System.Byte
Remarks

return The widget text

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static TextBlock New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
TextBlock
| Improve this Doc View Source

SetAutoWrapText(Boolean)

Set the auto wrap for this text block.

Declaration
public void SetAutoWrapText(bool InAutoTextWrap)
Parameters
Type Name Description
System.Boolean InAutoTextWrap
Remarks

@param InAutoTextWrap to turn wrap on or off.

| Improve this Doc View Source

SetColorAndOpacity(SlateColor)

Sets the color and opacity of the text in this text block @

Declaration
public void SetColorAndOpacity(SlateColor InColorAndOpacity)
Parameters
Type Name Description
SlateColor InColorAndOpacity
Remarks

param InColorAndOpacity The new text color and opacity

| Improve this Doc View Source

SetFont(SlateFontInfo)

Dynamically set the font info for this text block @

Declaration
public void SetFont(SlateFontInfo InFontInfo)
Parameters
Type Name Description
SlateFontInfo InFontInfo
Remarks

param InFontInfo THe new font info

| Improve this Doc View Source

SetJustification(Byte)

Set the text justification for this text block @

Declaration
public void SetJustification(byte InJustification)
Parameters
Type Name Description
System.Byte InJustification
Remarks

param InJustification new justification

| Improve this Doc View Source

SetMinDesiredWidth(Single)

Set the minimum desired width for this text block @

Declaration
public void SetMinDesiredWidth(float InMinDesiredWidth)
Parameters
Type Name Description
System.Single InMinDesiredWidth
Remarks

param InMinDesiredWidth new minimum desired width

| Improve this Doc View Source

SetOpacity(Single)

Sets the opacity of the text in this text block @

Declaration
public void SetOpacity(float InOpacity)
Parameters
Type Name Description
System.Single InOpacity
Remarks

param InOpacity The new text opacity

| Improve this Doc View Source

SetShadowColorAndOpacity(LinearColor)

Sets the color and opacity of the text drop shadow Note: if opacity is zero no shadow will be drawn @

Declaration
public void SetShadowColorAndOpacity(LinearColor InShadowColorAndOpacity)
Parameters
Type Name Description
LinearColor InShadowColorAndOpacity
Remarks

param InShadowColorAndOpacity The new drop shadow color and opacity

| Improve this Doc View Source

SetShadowOffset(Vector2D)

Sets the offset that the text drop shadow should be drawn at @

Declaration
public void SetShadowOffset(Vector2D InShadowOffset)
Parameters
Type Name Description
Vector2D InShadowOffset
Remarks

param InShadowOffset The new offset

| Improve this Doc View Source

SetText(Byte)

Directly sets the widget text.

Declaration
public void SetText(byte InText)
Parameters
Type Name Description
System.Byte InText
Remarks

Warning: This will wipe any binding created for the Text property! @param InText The text to assign to the widget

Operators

| Improve this Doc View Source

Implicit(IntPtr to TextBlock)

Convert from IntPtr to UObject

Declaration
public static implicit operator TextBlock(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
TextBlock
  • Improve this Doc
  • View Source
Back to top Generated by DocFX