Reordering and Hiding Properties

Details Panel Customizations can change the order in which properties appear in the Details Panel, as well as show or hide properties that wouldn't ordinarily be visible. This page provides instructions on how to show, hide, and reorder both properties and categories.

Prerequisites

This page uses the Details Panel Quickstart tutorial as the basis for its examples and refers to the following:

• FCustomDataProperty – A custom struct consisting of the following:

  • TSoftObjectPtr<UTexture> CustomTexture

  • FName CustomName

  • FString CustomString

  • Int32 CustomInt

• ACustomActor – A simple Actor with the following added properties:

  • TSoftObjectPtr<UStaticMesh> CustomMesh

  • float CustomFloat

  • bool CustomBool

  • FCustomDataProperty CustomData

• FCustomDataPropertyCustomization – A Property Type Customization for FCustomDataProperty.

• FCustomClassDetailsCustomization – A Detail Customization for ACustomActor.

You should also review Refreshing the Details Panel if you want to show or hide details based on changes made by the user.

Properties

Reorder Properties

You can re-order properties by changing the order in which you make AddProperty calls. The Class Details customization in the Details Panel Quickstart includes an example of re-ordering properties. The original property declarations for ACustomActor are as follows:

UPROPERTY(EditAnywhere)
	TSoftObjectPtr<UStaticMesh> CustomMesh;

	UPROPERTY(EditAnywhere)
	float CustomFloat;

	UPROPERTY(EditAnywhere)
	bool CustomBool;

	UPROPERTY(EditAnywhere)

Normally, CustomMesh and CustomFloat would appear first in the Details Panel. However, the FCustomClassDetailsCustomization::CustomizeDetails function adds them to the details panel as follows:

CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomData));
	CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomBool));
	CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomMesh));
	CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomFloat));

This results in CustomData and CustomBool appearing first. Similarly, any other custom Slate elements will appear in the order that you add them.

Hide Properties

Use IDetailCategoryBuilder::HideProperty to selectively hide properties that would normally appear due to their UPROPERTY specifiers.

DetailBuilder.HideProperty(FCustomDataProperty::StaticStruct()->GetFName());

Categories

Reorder Categories

Use IDetailCategoryBuilder::SortCategories to set the order your custom categories render in.

IDetailCategoryBuilder::SortCategories takes a delegate with the signature void FunctionName (const TMap<FName, IDetailCategoryBuilder*>&). Any functions you use for this delegate must be static functions. The TMap is a map of all the categories added by your custom class. Once you fetch a category from it, use IDetailCategoryBuilder::SetSortOrder to change what order the categories appear in. IDetailCategoryBuilder::SetSortOrder always sorts from lowest to highest.

static void SortCustomDetailsCategories(const TMap<FName, IDetailCategoryBuilder*>& AllCategoryMap);

//Custom details with two category names.

	void FCustomClassDetailsCustomization::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
	{
		IDetailCategoryBuilder& CustomCategory = DetailBuilder.EditCategory(FName("Custom Settings"));
		IDetailCategoryBuilder& DataCategory = DetailBuilder.EditCategory(FName("Data"));
		CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomBool));
		CustomCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomMesh));
		DataCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomData));
		DataCategory.AddProperty(GET_MEMBER_NAME_CHECKED(ACustomActor, CustomFloat));

Hide Categories

Use IDetailCategoryBuilder::HideCategory to hide an entire category. You can use categories you defined with UPROPERTY specifiers or one you defined as part of a detail customization. Provide the FName of the category.

void FCustomClassDetailsCustomization::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
	{
		FName CustomCategoryName = FName("Custom Settings");
		IDetailCategoryBuilder& CustomCategory = DetailBuilder.EditCategory(CustomCategoryName);
		DetailBuilder.HideCategory(CustomCategoryName);
	}

Advanced Categories

Use IDetailCategoryBuilder::SetShowAdvanced to designate a category to show only when you expand the Advanced section of the Details Panel.

void FCustomClassDetailsCustomization::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
	{
		FName CustomCategoryName = FName("Custom Settings");
		IDetailCategoryBuilder& CustomCategory = DetailBuilder.EditCategory(CustomCategoryName);
		CustomCategory.SetShowAdvanced(true);
	}