weisang.com > Documents Articles > AssignHeader Property (FPScript)

AssignHeader Property (FPScript)

09.03.2021

Read access to the Header Information attribute of a data object. Read/write access to the Header Information attribute of the current formula.

Syntax

[DataObject].AssignHeader

or

[this].AssignHeader = Option

The syntax of the AssignHeader property consists of the following elements:

Element

Description

DataObject

Optional. The data object being accessed. If you omit this element, then the current formula is accessed. For an embedded FPScript, you need to use the This keyword.

Option

Select one of the following constants:

Constant

Description

fpAssignHeaderAutomatic

Uses a suitable setting based on the object type and properties.

fpAssignHeaderNever

No header information is assigned.

Select this option if the formula is not going to carry out any calculations, but will only pass data unchanged, such as data summarized in a list.

fpAssignHeaderIfNoneAssigned

If the calculated result already has assigned header information, then this header information is not replaced. Otherwise, the header information of this formula is assigned.

fpAssignHeaderAlways

The header information of this formula is always assigned, even if other header information has already been assigned to the result.

Remarks

Determines the cases in which the header information of the formula should be assigned to the result.

Write access to the header information of a data object is only allowed for the formula that contains the FPScript code. You should only use this option in embedded FPScript. For standard formula objects, you should edit the attribute on theGeneral tab of the Properties dialog box instead.

Available in

FlexPro Basic, Professional, Developer Suite

Examples

\Formula.AssignHeader

Provides the current attribute setting for the specified formula.

.AssignHeader = fpAssignHeaderAlways

Ensures that the formula header information is assigned to the formula result.

Share article or send as email:

You might be interested in these articles