USheetSerializationSubSystem

Used to serialize data for copying/pasting to/from spreadsheets (in Excel or Sheets).

API > API/Editor > API/Editor/UnrealEd

Used to serialize data for copying/pasting to/from spreadsheets (in Excel or Sheets). Properties can be customized to be processed in a specific fashion.

   
Name USheetSerializationSubSystem
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/SheetSerialization.h
Include Path #include "SheetSerialization.h"

Syntax

UCLASS (MinimalAPI)  
class USheetSerializationSubSystem : public UEditorSubsystem

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CellGetters TMap< FString, FFillCellsFromProperty >   SheetSerialization.h  
HeaderGetters TMap< FString, FFillHeadersFromProperty >   SheetSerialization.h  
PropertySetters TMap< FString, FSetPropertyFromCells >   SheetSerialization.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString ExportForSheet ( TArray< FDataTableRowData >& Rows,
UDataTable* DataTable,
const bool IncludeHeaders
)

 Serialize the specified rows from the given data table into a format able to be pasted into a spreadsheet, optionally including headers. SheetSerialization.h  

int32 FillCellsFromObject ( FSheetData& SheetData,
const FIntPoint StartingPosition,
void* InObject,
UObject* Parent,
const UStruct* RowStruct
)

 Fill cell values into the sheet data for the given object, returning the number of rows used. SheetSerialization.h  

int32 FillCellsFromProperty ( FSheetData& SheetData,
const FIntPoint StartingPosition,
void* InObject,
UObject* Parent,
const FProperty* InProperty
)

 Fill cell values into the sheet data for the given property, returning the number of rows used. SheetSerialization.h  

int32 FillHeadersFromProperty ( FSheetData& SheetData,
const FProperty* InProperty,
const FProperty* ParentProperty,
const FString* ParentName
)

 Fill headers into the sheet data for the given property, returning the number of columns used. SheetSerialization.h  

int32 FillHeadersFromStruct ( FSheetData& SheetData,
const UStruct* InStruct,
const FString* ParentName
)

 Fill headers into the sheet data for the given struct, returning the number of columns used. SheetSerialization.h  

bool ImportFromSheet ( const FString& SheetText,
UDataTable* DataTable,
FOutputDevice* ErrorText
)

 Deserialize clipboard text from a spreadsheet into the given data table, replacing all of its contents with that from the spreadsheet. SheetSerialization.h  

bool ImportRowFromSheet ( const FString& SheetText,
UDataTable* DataTable,
FName& OutRowName,
uint8* RowPtr,
FOutputDevice* ErrorText
)

 Deserialize clipboard text from a spreadsheet into a single row of the given data table, replacing the row's contents with that from the spreadsheet Does not change the row's name, but outputs the new desired row name so that it may be changed separately. SheetSerialization.h  

void SetObjectFromCells ( FSheetData& SheetData,
const FIntPoint StartingPosition,
int32 ObjectRowCount,
void* InObject,
UObject* Parent,
const UStruct* RowStruct
)

 Sets the value for the object based on cells from the sheet data at the given starting position. SheetSerialization.h  

void SetPropertyFromCells ( FSheetData& SheetData,
const FIntPoint StartingPosition,
int32 ObjectRowCount,
void* InObject,
UObject* Parent,
const FProperty* InProperty
)

 Sets the value for the property of the object based on cells from the sheet data at the given starting position. SheetSerialization.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   SheetSerialization.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   SheetSerialization.h  

virtual void RegisterCellGetter ( const FString& PropertyClassName,
const FFillCellsFromProperty& GetCellsFromProperty
)

 Register the function to get cell values from the given property class. SheetSerialization.h  

virtual void RegisterHeaderGetter ( const FString& PropertyClassName,
const FFillHeadersFromProperty& GetHeaderFromProperty
)

 Register the function to get column headers from the given property class. SheetSerialization.h  

virtual void RegisterPropertySetter ( const FString& PropertyClassName,
const FSetPropertyFromCells& SetPropertyFromCells
)

 Register the function to set the value of the given property class from cell values. SheetSerialization.h  

virtual void UnregisterCellGetter ( const FString& PropertyClassName
)

 Unregister the function to get cell values from the given property class. SheetSerialization.h  

virtual void UnregisterHeaderGetter ( const FString& PropertyClassName
)

 Unregister the function to get column headers from the given property class. SheetSerialization.h  

virtual void UnregisterPropertySetter ( const FString& PropertyClassName
)

 Unregister the function to set the value of the given property class from cell values. SheetSerialization.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString & EscapeIfNecessary ( FString& CellData,
bool* OutModified
)

 Escape the cell data for proper spreadsheet formatting. SheetSerialization.h  
Gets the singleton. SheetSerialization.h  

static FString & UnEscapeIfNecessary ( FString& CellData,
bool* OutModified
)

 Unescape the cell data coming from a spreadsheet. SheetSerialization.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page