Class ComponentCustomScripting

This class represents the API for custom scripting related to components. You can access all the methods by using the namespace CSL.component.

Hierarchy

ComponentCustomScripting

Index

Methods

getAll getByName reload

Methods

getAll

getAll(): ComponentInstance[]
Get all the components on the page. A component is an ADM or CM.
```
const components = CSL.component.getAll();
```
Returns
An array of objects containing the id, object name and view name of the component.
Returns ComponentInstance[]
- Defined in adm/src/lib/custom-scripting/component.ts:40

getByName

getByName(objectName: string, viewName: string): ComponentInstance[]
Get a single component on the page by its object and view name.
```
CSL.component.getByName('Product', 'Get All Products');
```
Returns
An array of objects containing the id, object name and view name of the component(s) when found.
Parameters
- objectName: string
  
  The name of the object
- viewName: string
  
  The name of the view.
Returns ComponentInstance[]
- Defined in adm/src/lib/custom-scripting/component.ts:69

reload

reload(objectName: string, viewName: string): void
Reloads the component with the given object and view name.
```
CSL.component.reload('Product', 'Get All Products');
```
Parameters
- objectName: string
  
  The name of the object.
- viewName: string
  
  The name of the view.
Returns void
- Defined in adm/src/lib/custom-scripting/component.ts:82

Generated using TypeDoc