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 > IDetailLayoutBuilder::GetProperty

Light Theme

Dark Theme

IDetailLayoutBuilder::GetProperty

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.

Windows

MacOS

Linux

References

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

Syntax

TSharedRef< IPropertyHandle > GetProperty
(
    const FName PropertyPath,
    const UStruct * ClassOutermost,
    FName InstanceName
) const

Remarks

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. Instructions

struct MyStruct { int32 StaticArray[3]; float FloatVar; }

class MyActor { MyStruct Struct1; MyStruct Struct2; float MyFloat }

To access StaticArray at index 2 from Struct2 in MyActor, your path would be MyStruct.StaticArray[2]" and your instance name is "Struct2" To access MyFloat in MyActor you can just pass in "MyFloat" because the name of the property is unambiguous

Parameters

Parameter	Description
Path	The path to the property. Can be just a name of the property or a path in the format outer.outer.value[optional_index_for_static_arrays]
ClassOutermost	Optional outer class if accessing a property outside of the current class being customized
InstanceName	Optional instance name if multiple FProperty's of the same type exist. such as two identical structs, the instance name is one of the struct variable names) Examples:

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

Take our survey

Dismiss