Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Framework > Text > FSyntaxHighlighterTextLayoutMarshaller

Light Theme

Dark Theme

FSyntaxHighlighterTextLayoutMarshaller

Get/set the raw text to/from a text layout, and also inject syntax highlighting

Windows

MacOS

Linux

Inheritance Hierarchy

ITextLayoutMarshaller

FBaseTextLayoutMarshaller

FPlainTextLayoutMarshaller

FSyntaxHighlighterTextLayoutMarshaller

FRichTextSyntaxHighlighterTextLayoutMarshaller

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Text/SyntaxHighlighterTextLayoutMarshaller.h
Include	#include "Framework/Text/SyntaxHighlighterTextLayoutMarshaller.h"

Syntax

class FSyntaxHighlighterTextLayoutMarshaller : public FPlainTextLayoutMarshaller

Remarks

Get/set the raw text to/from a text layout, and also inject syntax highlighting

Variables

		Name	Description
	bool	bSyntaxHighlightingEnabled	True if syntax highlighting is enabled, false to fallback to plain text
	TSharedPtr< FSy...	Tokenizer	Tokenizer used to style the text

Constructors

	Name	Description
	FSyntaxHighlighterTextLayoutMarshaller ( TSharedPtr< FSyntaxTokenizer > InTo... )

Destructors

	Name	Description
	~FSyntaxHighlighterTextLayoutMarshaller()

Functions

		Name	Description
	void	EnableSyntaxHighlighting ( const bool bEnable )
	bool	IsSyntaxHighlightingEnabled()
	void	ParseTokens ( const FString& SourceString, FTextLayout& TargetTextLayout, TArray< FSyntaxTokenizer::FTokenize... )

Overridden from ITextLayoutMarshaller

		Name	Description
	bool	RequiresLiveUpdate()	Return true if the marshaller requires the text be updated "live" (eg, because it inserts formatting directly into the source text) Returning true will cause SetText to be called every time the source text is changed, which is costly, but required for things like syntax highlighting
	void	SetText ( const FString& SourceString, FTextLayout& TargetTextLayout )	ITextLayoutMarshaller.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss