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 > Editor > PropertyEditor > IDetailLayoutBuilder

Light Theme

Dark Theme

IDetailLayoutBuilder

The builder for laying custom details

Windows

MacOS

Linux

References

Module	PropertyEditor
Header	/Engine/Source/Editor/PropertyEditor/Public/DetailLayoutBuilder.h
Include	#include "DetailLayoutBuilder.h"

Syntax

class IDetailLayoutBuilder

Remarks

The builder for laying custom details

Destructors

	Name	Description
	~IDetailLayoutBuilder()

Functions

	Name	Description
FDetailWidge...	AddCustomRowToCategory ( TSharedPtr< IPropertyHandle > InPro..., const FText& InCustomSearchString, bool bForAdvanced )	Adds a custom row to the property's category automatically.
IDetailPrope...	AddPropertyToCategory ( TSharedPtr< IPropertyHandle > InPro... )	Adds the property to its given category automatically.
IDetailCateg...	EditCategory ( FName CategoryName, const FText& NewLocalizedDisplayNa..., ECategoryPriority::Type CategoryTyp... )	Edits an existing category or creates a new one
IDetailPrope...	EditDefaultProperty ( TSharedPtr< IPropertyHandle > InPro... )	Allows for the customization of a property row for a property that already exists on a class being edited in the details panel The property will remain in the default location but the widget or other attributes for the property can be changed Note This cannot be used to customize other customizations
void	ForceRefreshDetails()	Refreshes the details view and regenerates all the customized layouts Use only when you need to remove or add complicated dynamic items
UClass *	GetBaseClass()
void	GetCategoryNames ( TArray< FName >& OutCategoryNames )	Gets the current set of existing category names.
FSlateFontIn...	GetDetailFont()
FSlateFontIn...	GetDetailFontBold()
FSlateFontIn...	GetDetailFontItalic()
const IDetai...	GetDetailsView()
void	GetObjectsBeingCustomized ( TArray< TWeakObjectPtr< UObject > >... )	Gets the current object(s) being customized by this builder
TSharedRef< ...	GetProperty ( const FName PropertyPath, const UStruct* ClassOutermost, FName InstanceName )	Gets a handle to a property which can be used to read and write the property value and identify the property in other detail customization interfaces.
const TShare...	GetPropertyUtilities()
const TArray...	GetSelectedObjects()	Get the root objects observed by this layout.
void	GetStructsBeingCustomized ( TArray< TSharedPtr< FStructOnScope ... )	Gets the current struct(s) being customized by this builder
TSharedPtr< ...	GetThumbnailPool()	Gets the thumbnail pool that should be used for rendering thumbnails in the details view
FName	GetTopLevelProperty()	Gets the top level property, for showing the warning for experimental or early access class
bool	HasClassDefaultObject()
void	HideCategory ( FName CategoryName )	Hides an entire category
void	HideProperty ( const TSharedPtr< IPropertyHandle >... )	Hides a property from view
void	HideProperty ( FName PropertyPath, const UStruct* ClassOutermost, FName InstanceName )	Hides a property from view
bool	IsPropertyVisible ( TSharedRef< IPropertyHandle > Prope... )
bool	IsPropertyVisible ( const FPropertyAndParent& Property... )
void	RegisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName, FOnGetPropertyTypeCustomizationInst..., TSharedPtr< IPropertyTypeIdentifier... )	Registers a custom detail layout delegate for a specific type in this layout only

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

Take our survey

Dismiss