IDocumentationPage

Choose your operating system:

Windows

macOS

Linux

References

Module

Documentation

Header

/Engine/Source/Editor/Documentation/Public/IDocumentationPage.h

Include

#include "IDocumentationPage.h"

Syntax

class IDocumentationPage

Functions

Name Description

Public function

bool

 

GetExcerpt

(
    const FString& ExcerptName,
    FExcerpt& Excerpt
)

Populates the argument excerpt with this content found using the excer

Public function

bool

 

GetExcerptContent

(
    FExcerpt& Excerpt
)

Builds the Excerpt content using the excerpt name from the argument

Public function

void

 

GetExcerpts

(
    TArray< FExcerpt >& Excerpts
)

Populates the argument TArray with Excerpts this page contains

Public function Const

int32

 

GetNumExcerpts()

Return the number of excerpts this page holds

Public function

FText

 

GetTitle()

Returns the title of the excerpt

Public function

bool

 

HasExcerpt

(
    const FString& ExcerptName
)

Returns true if this page contains a match for the ExcerptName

Public function

void

 

Reload()

Rebuilds the excerpt content

Public function

void

 

SetTextWrapAt

(
    TAttribute< float > WrapAt
)

Sets the argument as the width control for text wrap in the excerpt widgets