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

Inheritance Hierarchy

  • TSharedFromThis< IPropertyHandle >
  • IPropertyHandle

References

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

Syntax

class IPropertyHandle : public TSharedFromThis< IPropertyHandle >

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AccessRawData ( TArray< const void* >& RawData
)

  
Public function void

AccessRawData ( TArray< void* >& RawData
)

 Accesses the raw data of this property. (Each pointer can be cast to the property data type)
Public function TArray< TSharedPtr< IPropertyHandle > >

AddChildStructure ( TSharedRef< IStructureDataProvider > ChildStructure
)

  
Public function TArray< TSharedPtr< IPropertyHandle > >

AddChildStructure ( TSharedRef< FStructOnScope > ChildStructure
)

 Adds a child structure
Public function void

AddRestriction ( TSharedRef< const FPropertyRestriction > Restriction
)

 Adds a restriction to the possible values for this property.
Public function TSharedPtr< IPropertyHandleArray >

AsArray ()

 Returns this handle as an array if possible
Public function TSharedPtr< IPropertyHandleMap >

AsMap ()

  
Public function TSharedPtr< IPropertyHandleOptional >  
Public function TSharedPtr< IPropertyHandleSet >

AsSet ()

  
Public function TSharedPtr< IPropertyHandleStruct >  
Public function Const bool Returns whether or not the property can be set to default
Public function void Marks this property as not having a custom reset to default (useful when a widget customizing reset to default goes away)
Public function Const TSharedRef< SWidget > Creates the default buttons which appear next to value widgets.
Public function Const void

CreateDefaultPropertyCopyPasteActions ( FUIAction& OutCopyAction,
FUIAction& OutPasteAction
)

 Creates the default copy and paste actions for a single property.
Public function Const TSharedPtr< FPropertyPath > Helper to fetch a PropertyPath
Public function Const TSharedRef< SWidget >

CreatePropertyNameWidget ( const FText& NameOverride,
const FText& ToolTipOverride
)

 Creates a name widget for this property
Public function Const TSharedRef< SWidget >

CreatePropertyNameWidget ( const FText& NameOverride,
const FText& ToolTipOverride,
bool bDisplayResetToDefault,
bool bDisplayText,
bool bDisplayThumbnail
)

 Creates a name widget for this property
Public function Const TSharedRef< SWidget >

CreatePropertyValueWidget ( bool bDisplayDefaultPropertyButtons
)

 Creates a value widget for this property
Public function TSharedRef< SWidget > Creates a value widget for this property using customization, if available.
Public function Const bool  
Public function Const void  
Public function void

EnumerateRawData ( const EnumerateRawDataFuncRef& InRawDataCallback
)

 Return true to continue enumeration
Public function void

ExecuteCustomResetToDefault ( const FResetToDefaultOverride& OnCustomResetToDefault
)

 Sets an override for this property's reset to default behavior
Public function Const FString Generates a path from the parent UObject class to this property
Public function 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
Public function bool

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

 Generates a list of possible enum/class options for the property
Public function Const bool

GenerateRestrictionToolTip ( const FString& Value,
FText& OutTooltip
)

 Generates a consistent tooltip describing this restriction for use in the editor.
Public function Const int32 Helper to fetch the ArrayIndex
Public function Const bool

GetBoolMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return bool
Public function Const TSharedPtr< IPropertyHandle >

GetChildHandle ( FName ChildName,
bool bRecurse
)

 Gets a child handle of this handle.
Public function Const TSharedPtr< IPropertyHandle > Gets a child handle of this handle. Useful for accessing properties in structs.
Public function Const UClass *

GetClassMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return UClass*
Public function Const FName 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
Public function Const FText 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
Public function FString  
Public function FString  
Public function Const double

GetDoubleMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return double
Public function Const float

GetFloatMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return float
Public function Const int32  
Public function Const const FString *

GetInstanceMetaData ( const FName& Key
)

 Get metadata value for 'Key' for this property instance (as opposed to the class)
Public function Const const TMap< FName, FString > * Get metadata map for this property instance (as opposed to the class)
Public function Const int32

GetIntMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return int32
Public function Const TSharedPtr< IPropertyHandle >  
Public function Const const FString &

GetMetaData ( const FName& Key
)

 Find the metadata value associated with the key
Public function Const FProperty * Gets the property we should use to read meta-data
Public function Const FPropertyAccess::Result

GetNumChildren ( uint32& OutNumChildren
)

  
Public function Const uint32  
Public function Const int32 Gets the number of objects that this handle is editing
Public function Const const UClass * Get the shared base class of the objects that contain this property.
Public function Const void

GetOuterObjects ( TArray< UObject* >& OuterObjects
)

 Get the objects that contain this property
Public function Const void

GetOuterPackages ( TArray< UPackage* >& OuterPackages
)

 Get the packages that contain this property
Public function Const void

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

 Get the structures that contain this property
Public function Const TSharedPtr< IPropertyHandle >  
Public function Const FPropertyAccess::Result

GetPerObjectValue ( const int32 ObjectIndex,
FString& OutObjectValue
)

 Gets a value for the specified object that this handle is editing
Public function Const FPropertyAccess::Result

GetPerObjectValues ( TArray< FString >& OutPerObjectValues
)

 Gets a unique value for each object this handle is editing
Public function Const FProperty * Gets the property being edited
Public function Const const FFieldClass * Gets the class of the property being edited
Public function Const FText  
Public function Const FStringView Helper to fetch a PropertyPath
Public function Const FText  
Public function Const FText Gets the property tool tip text.
Public function Const FPropertyAccess::Result

GetValue ( FVector2D& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FQuat& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FRotator& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( UObject*& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( const UObject*& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FAssetData& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FVector4& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FProperty*& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FText& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( double& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( bool& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( int8& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( int16& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( int32& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( int64& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( uint8& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( uint16& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( uint32& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( uint64& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FString& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( float& OutValue
)

 Gets the typed value of a property.
Public function Const FPropertyAccess::Result

GetValue ( const FProperty*& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FVector& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValue ( FName& OutValue
)

  
Public function Const FPropertyAccess::Result

GetValueAsDisplayString ( FString& OutValue,
EPropertyPortFlags PortFlags
)

 Gets the value formatted as a string, possibly using an alternate form more suitable for display in the UI
Public function Const FPropertyAccess::Result

GetValueAsDisplayText ( FText& OutValue
)

 Gets the value formatted as a string, as Text, possibly using an alternate form more suitable for display in the UI
Public function Const FPropertyAccess::Result

GetValueAsFormattedString ( FString& OutValue,
EPropertyPortFlags PortFlags
)

 Gets the value formatted as a string.
Public function Const FPropertyAccess::Result

GetValueAsFormattedText ( FText& OutValue
)

 Gets the value formatted as a string, as Text.
Public function Const uint8 * Calculates the memory address for the data associated with this item's value.
Public function Const FPropertyAccess::Result

GetValueData ( void*& OutAddress
)

  
Public function bool  
Public function Const bool

HasMetaData ( const FName& Key
)

 Determines if the property has any metadata associated with the key
Public function Const bool  
Public function Const bool  
Public function Const bool

IsDisabled ( const FString& Value
)

 Tests if a value is disabled for this property
Public function Const bool

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

 Tests if a value is disabled for this property.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsHidden ( const FString& Value
)

 Tests if a value is hidden for this property
Public function Const bool

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

 Tests if a value is hidden for this property.
Public function Const bool  
Public function Const bool

IsRestricted ( const FString& Value
)

 Tests if a value is restricted for this property
Public function Const bool

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

 Tests if a value is restricted for this property.
Public function Const bool

IsSamePropertyNode ( TSharedPtr< IPropertyHandle > OtherHandle
)

  
Public function Const bool  
Public function void Marks this property has hidden by customizaton (will not show up in the default place)
Public function 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)
Public function void 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
Public function 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
Public function void 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
Public function void

ReplaceOuterObjects ( const TArray< UObject* >& OuterObjects
)

 Set the outer objects for this property
Public function void Indicates that children of this node should be rebuilt next tick.
Public function void Resets the value to its default
Public function void

SetExpanded ( bool bExpanded
)

 Sets the expanded flag for this property.
Public function void

SetIgnoreValidation ( bool bInIgnore
)

 Sets whether or not data validation should occur for this property and all of its children.
Public function void

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

 Set metadata value for 'Key' to 'Value' on this property instance (as opposed to the class)
Public function FPropertyAccess::Result Sets the object value from the current editor selection Will fail if this handle isn't an object property
Public function void

SetOnChildPropertyValueChanged ( const FSimpleDelegate& InOnChildPropertyValueChanged
)

 Sets a delegate to call when the value of the property of a child is changed
Public function 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
Public function void

SetOnChildPropertyValuePreChange ( const FSimpleDelegate& InOnChildPropertyValuePreChange
)

 Sets a delegate to call when the value of the property of a child is about to be changed
Public function void

SetOnPropertyResetToDefault ( const FSimpleDelegate& InOnPropertyResetToDefault
)

 Sets a delegate to call when the property is reset to default
Public function void

SetOnPropertyValueChanged ( const FSimpleDelegate& InOnPropertyValueChanged
)

 Sets a delegate to call when the value of the property is changed
Public function 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
Public function void

SetOnPropertyValuePreChange ( const FSimpleDelegate& InOnPropertyValuePreChange
)

 Sets a delegate to call when the value of the property is about to be changed
Public function FPropertyAccess::Result

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

 Sets a value on the specified object that this handle is editing
Public function FPropertyAccess::Result

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

 Sets a unique value for each object this handle is editing
Public function void

SetPropertyDisplayName ( FText InDisplayName
)

 Allows the handle to override the node's display name
Public function void

SetToolTipText ( const FText& ToolTip
)

 Sets the tooltip shown for this property
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

 Sets the typed value of a property.
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

  
Public function FPropertyAccess::Result

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

 Sets the value formatted as a string.

Typedefs

Name Description
EnumerateConstRawDataFuncRef Return true to continue enumeration
EnumerateRawDataFuncRef Enumerate the raw data of this property. (Each pointer can be cast to the property data type)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page