IPropertyTypeCustomization

Base class for property type customizations.

API > API/Editor > API/Editor/PropertyEditor

Base class for property type customizations. The property type customizations are used for Struct and instanced Object properties.

The CustomizeHeader() is used to customize the property row, and the CustomizeChildren() is called to add property rows under the header row. If CustomizeHeader() does not populate the row, the child rows will be added inline at the level where the header row would have gone.

Note for Object properties:

  • The customization is looked up based on the instanced Object type, or if multiple objects are edited, the common base class.
  • The PropertyHandle points to the property value (object pointer), the first child of PropertyHandle is the instanced object, and the instanced object properties are child of that.
   
Name IPropertyTypeCustomization
Type class
Header File /Engine/Source/Editor/PropertyEditor/Public/IPropertyTypeCustomization.h
Include Path #include "IPropertyTypeCustomization.h"

Syntax

class IPropertyTypeCustomization : public TSharedFromThis< IPropertyTypeCustomization >

Inheritance Hierarchy

Derived Classes

IPropertyTypeCustomization derived class hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPropertyTypeCustomization()

   IPropertyTypeCustomization.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CustomizeChildren ( TSharedRef< IPropertyHandle > PropertyHandle,
IDetailChildrenBuilder& ChildBuilder,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

 Called when the children of the property should be customized or extra rows added IPropertyTypeCustomization.h  

void CustomizeHeader ( TSharedRef< IPropertyHandle > PropertyHandle,
FDetailWidgetRow& HeaderRow,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

 Called when the header of the property (the row in the details panel where the property is shown) If nothing is added to the row, the header is not displayed IPropertyTypeCustomization.h  

virtual bool ShouldInlineKey()

   IPropertyTypeCustomization.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page