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 > IPropertyHandle

Light Theme

Dark Theme

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

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

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

	Name	Description
	~IPropertyHandle()

Functions

	Name	Description
void	AccessRawData ( TArray< const void* >& RawDat... )
void	AccessRawData ( TArray< void* >& RawData )	Accesses the raw data of this property. (Each pointer can be cast to the property data type)
TArray< TSha...	AddChildStructure ( TSharedRef< FStructOnScope > ChildS... )	Adds a child structure
void	AddRestriction ( TSharedRef< const class FPropertyRe... )	Adds a restriction to the possible values for this property.
TSharedPtr< ...	AsArray()	Returns this handle as an array if possible
TSharedPtr< ...	AsMap()
TSharedPtr< ...	AsSet()
bool	CanResetToDefault()	Returns whether or not the property can be set to default
void	ClearResetToDefaultCustomized()	Marks this property as not having a custom reset to default (useful when a widget customizing reset to default goes away)
TSharedRef< ...	CreateDefaultPropertyButtonWidgets()	Creates the default buttons which appear next to value widgets.
TSharedRef< ...	CreatePropertyNameWidget ( const FText& NameOverride, const FText& ToolTipOverride, bool bDisplayResetToDefault, bool bDisplayText, bool bDisplayThumbnail )	Creates a name widget for this property
TSharedRef< ...	CreatePropertyValueWidget ( bool bDisplayDefaultPropertyButtons )	Creates a value widget for this property
bool	DiffersFromDefault()
void	EnumerateConstRawData ( const EnumerateConstRawDataFuncRef ... )
void	EnumerateRawData ( const EnumerateRawDataFuncRef& InR... )	Return true to continue enumeration
void	ExecuteCustomResetToDefault ( const FResetToDefaultOverride& OnC... )	Sets an override for this property's reset to default behavior
FString	GeneratePathToProperty()	Generates a path from the parent UObject class to this property
bool	GeneratePossibleValues ( TArray< TSharedPtr< FString > >& O..., TArray< FText >& OutToolTips, TArray< bool >& OutRestrictedItems )	Generates a list of possible enum/class options for the property
bool	GenerateRestrictionToolTip ( const FString& Value, FText& OutTooltip )	Generates a consistent tooltip describing this restriction for use in the editor.
bool	GetBoolMetaData ( const FName& Key )	Find the metadata value associated with the key and return bool
TSharedPtr< ...	GetChildHandle ( FName ChildName, bool bRecurse )	Gets a child handle of this handle.
TSharedPtr< ...	GetChildHandle ( uint32 Index )	Gets a child handle of this handle. Useful for accessing properties in structs.
UClass *	GetClassMetaData ( const FName& Key )	Find the metadata value associated with the key and return UClass*
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
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
FString	GetDocumentationExcerptName()
FString	GetDocumentationLink()
float	GetFloatMetaData ( const FName& Key )	Find the metadata value associated with the key and return float
int32	GetIndexInArray()
const FStrin...	GetInstanceMetaData ( const FName& Key )	Get metadata value for 'Key' for this property instance (as opposed to the class)
const TMap< ...	GetInstanceMetaDataMap()	Get metadata map for this property instance (as opposed to the class)
int32	GetIntMetaData ( const FName& Key )	Find the metadata value associated with the key and return int32
TSharedPtr< ...	GetKeyHandle()
const FStrin...	GetMetaData ( const FName& Key )	Find the metadata value associated with the key
FProperty &#...	GetMetaDataProperty()	Gets the property we should use to read meta-data
FPropertyAcc...	GetNumChildren ( uint32& OutNumChildren )
uint32	GetNumOuterObjects()
int32	GetNumPerObjectValues()	Gets the number of objects that this handle is editing
void	GetOuterObjects ( TArray< UObject* >& OuterObje... )	Get the objects that contain this property
void	GetOuterPackages ( TArray< UPackage* >& OuterPac... )	Get the packages that contain this property
TSharedPtr< ...	GetParentHandle()
FPropertyAcc...	GetPerObjectValue ( const int32 ObjectIndex, FString& OutObjectValue )	Gets a value for the specified object that this handle is editing
FPropertyAcc...	GetPerObjectValues ( TArray< FString >& OutPerObjectVal... )	Gets a unique value for each object this handle is editing
FProperty &#...	GetProperty()	Gets the property being edited
const FField...	GetPropertyClass()	Gets the class of the property being edited
FText	GetPropertyDisplayName()
FText	GetResetToDefaultLabel()
FText	GetToolTipText()	Gets the property tool tip text.
FPropertyAcc...	GetValue ( FAssetData& OutValue )
FPropertyAcc...	GetValue ( const UObject*& OutValue )
FPropertyAcc...	GetValue ( FProperty*& OutValue )
FPropertyAcc...	GetValue ( float& OutValue )	Gets the typed value of a property.
FPropertyAcc...	GetValue ( double& OutValue )
FPropertyAcc...	GetValue ( bool& OutValue )
FPropertyAcc...	GetValue ( int8& OutValue )
FPropertyAcc...	GetValue ( int16& OutValue )
FPropertyAcc...	GetValue ( uint8& OutValue )
FPropertyAcc...	GetValue ( int64& OutValue )
FPropertyAcc...	GetValue ( uint16& OutValue )
FPropertyAcc...	GetValue ( uint32& OutValue )
FPropertyAcc...	GetValue ( uint64& OutValue )
FPropertyAcc...	GetValue ( FString& OutValue )
FPropertyAcc...	GetValue ( FText& OutValue )
FPropertyAcc...	GetValue ( FName& OutValue )
FPropertyAcc...	GetValue ( FVector& OutValue )
FPropertyAcc...	GetValue ( FVector2D& OutValue )
FPropertyAcc...	GetValue ( FVector4& OutValue )
FPropertyAcc...	GetValue ( FQuat& OutValue )
FPropertyAcc...	GetValue ( int32& OutValue )
FPropertyAcc...	GetValue ( const FProperty*& OutValue )
FPropertyAcc...	GetValue ( UObject*& OutValue )
FPropertyAcc...	GetValue ( FRotator& OutValue )
FPropertyAcc...	GetValueAsDisplayString ( FString& OutValue, EPropertyPortFlags PortFlags )	Gets the value formatted as a string, possibly using an alternate form more suitable for display in the UI
FPropertyAcc...	GetValueAsDisplayText ( FText& OutValue )	Gets the value formatted as a string, as Text, possibly using an alternate form more suitable for display in the UI
FPropertyAcc...	GetValueAsFormattedString ( FString& OutValue, EPropertyPortFlags PortFlags )	Gets the value formatted as a string.
FPropertyAcc...	GetValueAsFormattedText ( FText& OutValue )	Gets the value formatted as a string, as Text.
uint8 *	GetValueBaseAddress ( uint8* Base )	Calculates the memory address for the data associated with this item's value.
FPropertyAcc...	GetValueData ( void*& OutAddress )
bool	HasDocumentation()
bool	HasMetaData ( const FName& Key )	Determines if the property has any metadata associated with the key
bool	IsCustomized()
bool	IsDisabled ( const FString& Value, TArray< FText >& OutReasons )	Tests if a value is disabled for this property.
bool	IsDisabled ( const FString& Value )	Tests if a value is disabled for this property
bool	IsEditable()
bool	IsEditConst()
bool	IsHidden ( const FString& Value )	Tests if a value is hidden for this property
bool	IsHidden ( const FString& Value, TArray< FText >& OutReasons )	Tests if a value is hidden for this property.
bool	IsResetToDefaultCustomized()
bool	IsRestricted ( const FString& Value )	Tests if a value is restricted for this property
bool	IsRestricted ( const FString& Value, TArray< FText >& OutReasons )	Tests if a value is restricted for this property.
bool	IsValidHandle()
void	MarkHiddenByCustomization()	Marks this property has hidden by customizaton (will not show up in the default place)
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)
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
void	NotifyPostChange ( EPropertyChangeType::Type ChangeTyp... )	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
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
void	ResetToDefault()	Resets the value to its default
void	SetIgnoreValidation ( bool bInIgnore )	Sets whether or not data validation should occur for this property and all of its children.
void	SetInstanceMetaData ( const FName& Key, const FString& Value )	Set metadata value for 'Key' to 'Value' on this property instance (as opposed to the class)
FPropertyAcc...	SetObjectValueFromSelection()	Sets the object value from the current editor selection Will fail if this handle isn't an object property
void	SetOnChildPropertyValueChanged ( const FSimpleDelegate& InOnChildPr... )	Sets a delegate to call when the value of the property of a child is changed
void	SetOnChildPropertyValuePreChange ( const FSimpleDelegate& InOnChildPr... )	Sets a delegate to call when the value of the property of a child is about to be changed
void	SetOnPropertyResetToDefault ( const FSimpleDelegate& InOnPropert... )	Sets a delegate to call when the property is reset to default
void	SetOnPropertyValueChanged ( const FSimpleDelegate& InOnPropert... )	Sets a delegate to call when the value of the property is changed
void	SetOnPropertyValuePreChange ( const FSimpleDelegate& InOnPropert... )	Sets a delegate to call when the value of the property is about to be changed
FPropertyAcc...	SetPerObjectValue ( const int32 ObjectIndex, const FString& ObjectValue, EPropertyValueSetFlags::Type Flags )	Sets a value on the specified object that this handle is editing
FPropertyAcc...	SetPerObjectValues ( const TArray< FString >& PerObject..., EPropertyValueSetFlags::Type Flags )	Sets a unique value for each object this handle is editing
void	SetPropertyDisplayName ( FText InDisplayName )	Allows the handle to override the node's display name
void	SetToolTipText ( const FText& ToolTip )	Sets the tooltip shown for this property
FPropertyAcc...	SetValue ( const FName& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FVector& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FVector2D& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FVector4& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FQuat& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FAssetData& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( UObject*const& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const UObject*const& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FText& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const TCHAR* InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FRotator& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FString& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const uint8& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const uint32& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const uint16& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const int64& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const int32& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const int16& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const int8& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const bool& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const double& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const float& InValue, EPropertyValueSetFlags::Type Flags )	Sets the typed value of a property.
FPropertyAcc...	SetValue ( FProperty*const& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const uint64& InValue, EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	SetValue ( const FProperty*const& InValu..., EPropertyValueSetFlags::Type Flags )
FPropertyAcc...	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)

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

Take our survey

Dismiss