Interface FormBuilder

Hierarchy

ContainerBuilder<FormContainer, FormLayout, FormItemLayout, ComponentProperties>
- FormBuilder

Index

Methods

Methods

addFormItem

addFormItem(formComponent: FormComponent<Component> | FormComponentGroup, itemLayout?: FormItemLayout): void

- Defined in azdata/index.d.ts:2760
Creates a child component and adds it to this container.

Parameters
- formComponent: FormComponent<Component> | FormComponentGroup
  
  the component to be added
- Optional itemLayout: FormItemLayout
Returns void

addFormItems

addFormItems(formComponents: (FormComponent<Component> | FormComponentGroup)[], itemLayout?: FormItemLayout): void

- Defined in azdata/index.d.ts:2752
Creates a collection of child components and adds them all to this container

Parameters
- formComponents: (FormComponent<Component> | FormComponentGroup)[]
  
  the definitions
- Optional itemLayout: FormItemLayout
Returns void

component

component(): FormContainer

Inherited from ContainerBuilder.component
- Defined in azdata/index.d.ts:2695
Returns FormContainer

insertFormItem

insertFormItem(formComponent: FormComponent<Component> | FormComponentGroup, index?: number, itemLayout?: FormItemLayout): void

- Defined in azdata/index.d.ts:2768
Inserts a from component in a given position in the form. Returns error given invalid index

Parameters
- formComponent: FormComponent<Component> | FormComponentGroup
  
  Form component
- Optional index: number
  
  index to insert the component to
- Optional itemLayout: FormItemLayout
  
  Item Layout
Returns void

removeFormItem

removeFormItem(formComponent: FormComponent<Component> | FormComponentGroup): boolean

- Defined in azdata/index.d.ts:2773
Removes a from item from the from

Parameters
- formComponent: FormComponent<Component> | FormComponentGroup
Returns boolean

withFormItems

withFormItems(components: (FormComponent<Component> | FormComponentGroup)[], itemLayout?: FormItemLayout): FormBuilder

- Defined in azdata/index.d.ts:2744
Parameters
- components: (FormComponent<Component> | FormComponentGroup)[]
- Optional itemLayout: FormItemLayout
Returns FormBuilder

withItems

withItems(components: Component[], itemLayout?: FormItemLayout): ContainerBuilder<FormContainer, FormLayout, FormItemLayout, ComponentProperties>

Inherited from ContainerBuilder.withItems
- Defined in azdata/index.d.ts:2701
Parameters
- components: Component[]
- Optional itemLayout: FormItemLayout
Returns ContainerBuilder<FormContainer, FormLayout, FormItemLayout, ComponentProperties>

withLayout

withLayout(layout: FormLayout): ContainerBuilder<FormContainer, FormLayout, FormItemLayout, ComponentProperties>

Inherited from ContainerBuilder.withLayout
- Defined in azdata/index.d.ts:2700
Parameters
- layout: FormLayout
Returns ContainerBuilder<FormContainer, FormLayout, FormItemLayout, ComponentProperties>

withProperties

withProperties<U>(properties: U): ComponentBuilder<FormContainer, ComponentProperties>

Inherited from ContainerBuilder.withProperties
- Defined in azdata/index.d.ts:2696
Type parameters
- U
Parameters
- properties: U
Returns ComponentBuilder<FormContainer, ComponentProperties>

withValidation

withValidation(validation: (component: FormContainer) => boolean | Thenable<boolean>): ComponentBuilder<FormContainer, ComponentProperties>

Inherited from ContainerBuilder.withValidation
- Defined in azdata/index.d.ts:2697
Parameters
- validation: (component: FormContainer) => boolean | Thenable<boolean>
  - - (component: FormContainer): boolean | Thenable<boolean>
    - Parameters
      - component: FormContainer
      Returns boolean | Thenable<boolean>
Returns ComponentBuilder<FormContainer, ComponentProperties>

Generated using TypeDoc