pCon.basket - Plugin Development
    Preparing search index...

    Interface AddressFormOptions

    interface AddressFormOptions {
        addressEditRestriction?: UserRestriction;
        addressType: AddressType;
        contactEditRestriction?: UserRestriction;
        container: HTMLElement;
        owner: PluginComponent;
        padding?: string;
        projectInfo: ProjectInfo;
        requiredAddressFields?: readonly AddressFields[];
        requiredContactFields?: readonly ContactFields[];
        userRestrictions?: ReadonlySet<UserRestriction>;
        workflow?: ProjectWorkflow;
        beginBusySection?(): void;
        endBusySection?(): void;
    }

    Hierarchy (View Summary)

    Index
    addressEditRestriction?: UserRestriction

    Restriction which will used for the editability check of the address fields. (default: project.edit)

    addressType: AddressType

    Address type which will be edited with this address form.

    contactEditRestriction?: UserRestriction

    Restriction which will used for the editability check of the contact fields. (default: project.edit)

    container: HTMLElement

    Html container for the ui.

    Owner of this component.

    padding?: string

    CSS padding of this form. Can be used to override the default padding.

    projectInfo: ProjectInfo

    ProjectInfo which will be used from the ui.

    requiredAddressFields?: readonly AddressFields[]

    List of address fields which will be marked as required.

    requiredContactFields?: readonly ContactFields[]

    List of contact fields which will be marked as required.

    userRestrictions?: ReadonlySet<UserRestriction>

    Restrictions for the current user. If undefined the default restrictions of the application will be used.

    workflow?: ProjectWorkflow

    Currently active project workflow.

    • BeginBusySection and endBusySection can be defined to show a custom loading animation. If not defined a default animation will be shown.

      Returns void

    • BeginBusySection and endBusySection can be defined to show a custom loading animation. If not defined a default animation will be shown.

      Returns void