Procedure PivotTableReloadState(page, tag, statesource)

PivotTableReloadState

With the procedure PivotTableReloadState you can reload the state of a specific pivot table from either the developer or user state file.

PivotTableReloadState(
            page,       ! (input) scalar string expression
            tag,        ! (input) scalar string expression
            statesource ! (input) scalar string expression
        )

Arguments

page

A string expression representing the name of the page that contains the pivot table.

tag

A string expression representing the tag that identifies the pivot table.

statesource

A string expression representing the type of state to be reloaded. Possible values are:

  • DeveloperState: Reload the pivot table with a state that is present in the developer state file.

  • UserState: Reload the pivot table with a state that is present in the user state file.

  • None: Reload the pivot table as if no state was available.

Return Value

The procedure returns 1 on success. If it fails to reload the state for the specified object, then the return value is 0 and CurrentErrorMessage will contain a proper error message.

Note

  • You can specify a unique tag name for each page object on the Misc tab of the object properties dialog box.

  • The name of the state is specified by the Specific State Name property on the General tab of the pivot table properties dialog box.

  • This procedure will only reload the state when the Save Layout/State - By Developer property (or Save Layout/State - By End User when running in end-user mode) on the general tab of the pivot table properties dialog box, has been set to a value other than No.

See also

  • The Pivot Table example that comes with the AIMMS installation includes a library that uses this new function. It includes a right-mouse menu that can be assigned to a Pivot Table, after which the user can save, load, or delete states for that Pivot Table. You can include this library in your own project as well.

  • The functions PivotTableSaveState, PivotTableDeleteState.