Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.02 KB

File metadata and controls

74 lines (46 loc) · 2.02 KB
title description author ms.author ms.topic ms.date ms.reviewer audience ms.search.region
PageData type
Learna bout the PageData type, which represents the data that is loaded into a page and includes the getControlValue and setControlValue methods.
jasongre
jasongre
article
05/24/2022
josaw
Developer
Global

PageData type

[!include banner] [!include mobile app deprecated]

Represents the data that is loaded into a page.

Hierarchy

PageData

Index

Methods

Methods

getControlValue

getControlValue(controlName: string): any

Gets the value of a control directly from the data set loaded in the page. The "value" is loosely defined across all different types of controls and generally indicates the primary single field value displayed or interacted with the control. Some complex controls (e.g a lookup or a list) may not have a simple value and thus cannot be accessed via this API.

Parameters

Name Type Description
controlName string name of the control whose value is to be retrieved

Returns any

setControlValue

setControlValue(controlName: string, value: any): any

Sets the value of a control directly into the data set loaded in the page. The "value" is loosely defined across all different types of controls and generally indicates the primary single field value displayed or interacted with the control. Some complex controls (e.g a lookup or a list) may not have a simple value and thus cannot be accessed via this API.

Parameters

Name Type Description
controlName string Name of the control whose value is to be set
value any The value to be set

Returns any

[!INCLUDEfooter-include]