1. Epic GamesDeveloper
  3. IPropertyHandle

IPropertyHandle

A handle to a property which is used to read and write the value without needing to handle Pre/PostEditChange, transactions, package modification A handle also is used to identify the property in detail customization interfaces

API > API/Editor > API/Editor/PropertyEditor

A handle to a property which is used to read and write the value without needing to handle Pre/PostEditChange, transactions, package modification A handle also is used to identify the property in detail customization interfaces

   
Name IPropertyHandle
Type class
Header File /Engine/Source/Editor/PropertyEditor/Public/PropertyHandle.h
Include Path #include "PropertyHandle.h"

Syntax

class IPropertyHandle : public TSharedFromThis< IPropertyHandle >

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPropertyHandle()

   PropertyHandle.h  

Typedefs

Name Type Remarks Include Path
EnumerateConstRawDataFuncRef TFunctionRef< bool(const void *, const int32, const int32)> Return true to continue enumeration PropertyHandle.h
EnumerateRawDataFuncRef TFunctionRef< bool(void *, const int32, const int32)> Enumerate the raw data of this property. (Each pointer can be cast to the property data type) PropertyHandle.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AccessRawData ( TArray< const void* >& RawData
) const

   PropertyHandle.h  

void AccessRawData ( TArray< void* >& RawData
)

 Accesses the raw data of this property. (Each pointer can be cast to the property data type) PropertyHandle.h  
  PropertyHandle.h  
Adds a child structure PropertyHandle.h  

void AddRestriction ( TSharedRef< const FPropertyRestriction > Restriction
)

 Adds a restriction to the possible values for this property. PropertyHandle.h  
Returns this handle as an array if possible PropertyHandle.h  
  PropertyHandle.h  
  PropertyHandle.h  
  PropertyHandle.h  
  PropertyHandle.h  

bool CanResetToDefault()

 Returns whether or not the property can be set to default PropertyHandle.h  

void ClearResetToDefaultCustomized()

 Marks this property as not having a custom reset to default (useful when a widget customizing reset to default goes away) PropertyHandle.h  
Creates the default buttons which appear next to value widgets. PropertyHandle.h  

void CreateDefaultPropertyCopyPasteActions ( FUIAction& OutCopyAction,
FUIAction& OutPasteAction
) const

 Creates the default copy and paste actions for a single property. PropertyHandle.h  

TSharedPtr< FPropertyPath > CreateFPropertyPath()

 Helper to fetch a PropertyPath PropertyHandle.h  

TSharedRef< SWidget > CreatePropertyNameWidget ( const FText& NameOverride,
const FText& ToolTipOverride
) const

 Creates a name widget for this property PropertyHandle.h  

TSharedRef< SWidget > CreatePropertyNameWidget ( const FText& NameOverride,
const FText& ToolTipOverride,
bool bDisplayResetToDefault,
bool bDisplayText,
bool bDisplayThumbnail
) const

 Creates a name widget for this property PropertyHandle.h  

TSharedRef< SWidget > CreatePropertyValueWidget ( bool bDisplayDefaultPropertyButtons
) const

 Creates a value widget for this property PropertyHandle.h  
Creates a value widget for this property using customization, if available. PropertyHandle.h  

bool DiffersFromDefault()

   PropertyHandle.h  

void EnumerateConstRawData ( const EnumerateConstRawDataFuncRef& InRawDataCallback
) const

   PropertyHandle.h  

void EnumerateRawData ( const EnumerateRawDataFuncRef& InRawDataCallback
)

 Return true to continue enumeration PropertyHandle.h  

void ExecuteCustomResetToDefault ( const FResetToDefaultOverride& OnCustomResetToDefault
)

 Sets an override for this property's reset to default behavior PropertyHandle.h  

FString GeneratePathToProperty()

 Generates a path from the parent UObject class to this property PropertyHandle.h  

bool GeneratePossibleValues ( TArray< FString >& OutOptionStrings,
TArray< FText >& OutToolTips,
TArray< bool >& OutRestrictedItems,
TArray< FText >* OutDisplayNames
)

 Generates a list of possible enum/class options for the property DisplayNames is optional PropertyHandle.h  

bool GeneratePossibleValues ( TArray< TSharedPtr< FString > >& OutOptionStrings,
TArray< FText >& OutToolTips,
TArray< bool >& OutRestrictedItems
)

 Generates a list of possible enum/class options for the property PropertyHandle.h  

bool GenerateRestrictionToolTip ( const FString& Value,
FText& OutTooltip
) const

 Generates a consistent tooltip describing this restriction for use in the editor. PropertyHandle.h  

int32 GetArrayIndex()

 Helper to fetch the ArrayIndex PropertyHandle.h  

bool GetBoolMetaData ( const FName& Key
) const

 Find the metadata value associated with the key and return bool PropertyHandle.h  

TSharedPtr< IPropertyHandle > GetChildHandle ( FName ChildName,
bool bRecurse
) const

 Gets a child handle of this handle. PropertyHandle.h  

TSharedPtr< IPropertyHandle > GetChildHandle ( uint32 Index
) const

 Gets a child handle of this handle. Useful for accessing properties in structs. PropertyHandle.h  

UClass * GetClassMetaData ( const FName& Key
) const

 Find the metadata value associated with the key and return UClass* PropertyHandle.h  

FName GetDefaultCategoryName()

 Gets the category FName that a property is in at the default location defined by the class the property is in It does not handle the property being moved to another category during customization PropertyHandle.h  

FText GetDefaultCategoryText()

 Gets the category display name that a property is in at the default location defined by the class the property is in It does not handle the property being moved to another category during customization PropertyHandle.h  

FString GetDocumentationExcerptName()

   PropertyHandle.h  

FString GetDocumentationLink()

   PropertyHandle.h  

double GetDoubleMetaData ( const FName& Key
) const

 Find the metadata value associated with the key and return double PropertyHandle.h  

float GetFloatMetaData ( const FName& Key
) const

 Find the metadata value associated with the key and return float PropertyHandle.h  

int32 GetIndexInArray()

   PropertyHandle.h  

const FString * GetInstanceMetaData ( const FName& Key
) const

 Get metadata value for 'Key' for this property instance (as opposed to the class) PropertyHandle.h  

const TMap< FName, FString > * GetInstanceMetaDataMap()

 Get metadata map for this property instance (as opposed to the class) PropertyHandle.h  

int32 GetIntMetaData ( const FName& Key
) const

 Find the metadata value associated with the key and return int32 PropertyHandle.h  

TSharedPtr< IPropertyHandle > GetKeyHandle()

   PropertyHandle.h  

const FString & GetMetaData ( const FName& Key
) const

 Find the metadata value associated with the key PropertyHandle.h  

FProperty * GetMetaDataProperty()

 Gets the property we should use to read meta-data PropertyHandle.h  

FPropertyAccess::Result GetNumChildren ( uint32& OutNumChildren
) const

   PropertyHandle.h  

uint32 GetNumOuterObjects()

   PropertyHandle.h  

int32 GetNumPerObjectValues()

 Gets the number of objects that this handle is editing PropertyHandle.h  

const UClass * GetOuterBaseClass()

 Get the shared base class of the objects that contain this property. PropertyHandle.h  

void GetOuterObjects ( TArray< UObject* >& OuterObjects
) const

 Get the objects that contain this property PropertyHandle.h  

void GetOuterPackages ( TArray< UPackage* >& OuterPackages
) const

 Get the packages that contain this property PropertyHandle.h  

void GetOuterStructs ( TArray< TSharedPtr< FStructOnScope > >& OutStructs
) const

 Get the structures that contain this property PropertyHandle.h  

TSharedPtr< IPropertyHandle > GetParentHandle()

   PropertyHandle.h  

FPropertyAccess::Result GetPerObjectValue ( const int32 ObjectIndex,
FString& OutObjectValue
) const

 Gets a value for the specified object that this handle is editing PropertyHandle.h  

FPropertyAccess::Result GetPerObjectValues ( TArray< FString >& OutPerObjectValues
) const

 Gets a unique value for each object this handle is editing PropertyHandle.h  

FProperty * GetProperty()

 Gets the property being edited PropertyHandle.h  

const FFieldClass * GetPropertyClass()

 Gets the class of the property being edited PropertyHandle.h  

FText GetPropertyDisplayName()

   PropertyHandle.h  

FStringView GetPropertyPath()

 Helper to fetch a PropertyPath PropertyHandle.h  

FText GetResetToDefaultLabel()

   PropertyHandle.h  

FText GetToolTipText()

 Gets the property tool tip text. PropertyHandle.h  

FPropertyAccess::Result GetValue ( FVector2D& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( FQuat& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( FRotator& OutValue
) const

   PropertyHandle.h  
  PropertyHandle.h  

FPropertyAccess::Result GetValue ( const UObject*& OutValue
) const

   PropertyHandle.h  
  PropertyHandle.h  

FPropertyAccess::Result GetValue ( FVector4& OutValue
) const

   PropertyHandle.h  
  PropertyHandle.h  

FPropertyAccess::Result GetValue ( FText& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( double& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( bool& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( int8& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( int16& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( int32& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( int64& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( uint8& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( uint16& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( uint32& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( uint64& OutValue
) const

   PropertyHandle.h  
  PropertyHandle.h  

FPropertyAccess::Result GetValue ( float& OutValue
) const

 Gets the typed value of a property. PropertyHandle.h  

FPropertyAccess::Result GetValue ( const FProperty*& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( FVector& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValue ( FName& OutValue
) const

   PropertyHandle.h  

FPropertyAccess::Result GetValueAsDisplayString ( FString& OutValue,
EPropertyPortFlags PortFlags
) const

 Gets the value formatted as a string, possibly using an alternate form more suitable for display in the UI PropertyHandle.h  

FPropertyAccess::Result GetValueAsDisplayText ( FText& OutValue
) const

 Gets the value formatted as a string, as Text, possibly using an alternate form more suitable for display in the UI PropertyHandle.h  

FPropertyAccess::Result GetValueAsFormattedString ( FString& OutValue,
EPropertyPortFlags PortFlags
) const

 Gets the value formatted as a string. PropertyHandle.h  

FPropertyAccess::Result GetValueAsFormattedText ( FText& OutValue
) const

 Gets the value formatted as a string, as Text. PropertyHandle.h  

uint8 * GetValueBaseAddress ( uint8* Base
) const

 Calculates the memory address for the data associated with this item's value. PropertyHandle.h  

FPropertyAccess::Result GetValueData ( void*& OutAddress
) const

   PropertyHandle.h  

bool HasDocumentation()

   PropertyHandle.h  

bool HasMetaData ( const FName& Key
) const

 Determines if the property has any metadata associated with the key PropertyHandle.h  

bool IsCategoryHandle()

   PropertyHandle.h  

bool IsCustomized()

   PropertyHandle.h  

bool IsDisabled ( const FString& Value
) const

 Tests if a value is disabled for this property PropertyHandle.h  

bool IsDisabled ( const FString& Value,
TArray< FText >& OutReasons
) const

 Tests if a value is disabled for this property. PropertyHandle.h  

bool IsEditable()

   PropertyHandle.h  

bool IsEditConst()

   PropertyHandle.h  

bool IsExpanded()

   PropertyHandle.h  

bool IsFavorite()

   PropertyHandle.h  

bool IsHidden ( const FString& Value
) const

 Tests if a value is hidden for this property PropertyHandle.h  

bool IsHidden ( const FString& Value,
TArray< FText >& OutReasons
) const

 Tests if a value is hidden for this property. PropertyHandle.h  

bool IsResetToDefaultCustomized()

   PropertyHandle.h  

bool IsRestricted ( const FString& Value
) const

 Tests if a value is restricted for this property PropertyHandle.h  

bool IsRestricted ( const FString& Value,
TArray< FText >& OutReasons
) const

 Tests if a value is restricted for this property. PropertyHandle.h  

bool IsSamePropertyNode ( TSharedPtr< IPropertyHandle > OtherHandle
) const

   PropertyHandle.h  

bool IsValidHandle()

   PropertyHandle.h  

void MarkHiddenByCustomization()

 Marks this property has hidden by customizaton (will not show up in the default place) PropertyHandle.h  

void MarkResetToDefaultCustomized ( bool bCustomized
)

 Marks this property has having a custom reset to default (reset to default will not show up in the default place) PropertyHandle.h  

void NotifyFinishedChangingProperties()

 Called to manually notify root objects that this property has finished changing This does not need to be called when SetValue functions are used since it will be called automatically PropertyHandle.h  

void NotifyPostChange ( EPropertyChangeType::Type ChangeType
)

 Called to manually notify root objects that this property has changed This does not need to be called when SetValue functions are used since it will be called automatically PropertyHandle.h  

void NotifyPreChange()

 Called to manually notify root objects that this property is about to change This does not need to be called when SetValue functions are used since it will be called automatically PropertyHandle.h  

void RemoveChildren()

 Removes all children of this handle PropertyHandle.h  

void ReplaceOuterObjects ( const TArray< UObject* >& OuterObjects
)

 Set the outer objects for this property PropertyHandle.h  
Indicates that children of this node should be rebuilt next tick. PropertyHandle.h  

void ResetToDefault()

 Resets the value to its default PropertyHandle.h  

void SetExpanded ( bool bExpanded
)

 Sets the expanded flag for this property. PropertyHandle.h  

void SetIgnoreValidation ( bool bInIgnore
)

 Sets whether or not data validation should occur for this property and all of its children. PropertyHandle.h  

void SetInstanceMetaData ( const FName& Key,
const FString& Value
)

 Set metadata value for 'Key' to 'Value' on this property instance (as opposed to the class) PropertyHandle.h  

FPropertyAccess::Result SetObjectValueFromSelection()

 Sets the object value from the current editor selection Will fail if this handle isn't an object property PropertyHandle.h  

void SetOnChildPropertyValueChanged ( const FSimpleDelegate& InOnChildPropertyValueChanged
)

 Sets a delegate to call when the value of the property of a child is changed PropertyHandle.h  

void SetOnChildPropertyValueChangedWithData ( const TDelegate< void(const FPropertyChangedEvent&)>& InOnPropertyValueChanged
)

 Sets a delegate to call when the value of the property of a child is changed including the property changed event as parameter PropertyHandle.h  

void SetOnChildPropertyValuePreChange ( const FSimpleDelegate& InOnChildPropertyValuePreChange
)

 Sets a delegate to call when the value of the property of a child is about to be changed PropertyHandle.h  

void SetOnPropertyResetToDefault ( const FSimpleDelegate& InOnPropertyResetToDefault
)

 Sets a delegate to call when the property is reset to default PropertyHandle.h  

void SetOnPropertyValueChanged ( const FSimpleDelegate& InOnPropertyValueChanged
)

 Sets a delegate to call when the value of the property is changed PropertyHandle.h  

void SetOnPropertyValueChangedWithData ( const TDelegate< void(const FPropertyChangedEvent&)>& InOnPropertyValueChanged
)

 Sets a delegate to call when the value of the property is changed including the property changed event as parameter PropertyHandle.h  

void SetOnPropertyValuePreChange ( const FSimpleDelegate& InOnPropertyValuePreChange
)

 Sets a delegate to call when the value of the property is about to be changed PropertyHandle.h  

FPropertyAccess::Result SetPerObjectValue ( const int32 ObjectIndex,
const FString& ObjectValue,
EPropertyValueSetFlags::Type Flags
)

 Sets a value on the specified object that this handle is editing PropertyHandle.h  

FPropertyAccess::Result SetPerObjectValues ( const TArray< FString >& PerObjectValues,
EPropertyValueSetFlags::Type Flags
)

 Sets a unique value for each object this handle is editing PropertyHandle.h  

void SetPropertyDisplayName ( FText InDisplayName
)

 Allows the handle to override the node's display name PropertyHandle.h  

void SetToolTipText ( const FText& ToolTip
)

 Sets the tooltip shown for this property PropertyHandle.h  

FPropertyAccess::Result SetValue ( const TCHAR* InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FAssetData& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const UObject*const& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( UObject*const& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FRotator& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FQuat& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FVector4& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FVector2D& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FVector& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FName& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FText& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FString& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const int32& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const uint32& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const uint16& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const uint8& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const int64& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const int16& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const int8& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const bool& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const double& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const float& InValue,
EPropertyValueSetFlags::Type Flags
)

 Sets the typed value of a property. PropertyHandle.h  

FPropertyAccess::Result SetValue ( FProperty*const& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const uint64& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValue ( const FProperty*const& InValue,
EPropertyValueSetFlags::Type Flags
)

   PropertyHandle.h  

FPropertyAccess::Result SetValueFromFormattedString ( const FString& InValue,
EPropertyValueSetFlags::Type Flags
)

 Sets the value formatted as a string. PropertyHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page