Variable customFormUICodesConst

customFormUICodes: {
    action: {
        buttons: {
            options: { disabled: string; hidden: string; startSelected: string };
            positions: {
                left_side_only: string;
                main_only: string;
                right_side_only: string;
                status_bar_left_only: string;
                status_bar_only: string;
                status_bar_right_only: string;
                title_bar_only: string;
            };
            styles: { display_icon_as_text: string; plain_text: string };
        };
        titles: {
            formStyles: {
                fullscreen: string;
                fullscreen_status_bar: string;
                general: string;
                general_status_bar: string;
                gridMenu: string;
                gridMenu_status_bar: string;
                medium: string;
                medium_status_bar: string;
                wide: string;
                wide_status_bar: string;
            };
            options: { removeXButton: string };
        };
    };
    modal: {
        titles: {
            formStyles: {
                fullscreen: string;
                general: string;
                medium: string;
                wide: string;
            };
            options: { removeXButton: string };
        };
    };
} = ...

Type declaration

  • action: {
        buttons: {
            options: { disabled: string; hidden: string; startSelected: string };
            positions: {
                left_side_only: string;
                main_only: string;
                right_side_only: string;
                status_bar_left_only: string;
                status_bar_only: string;
                status_bar_right_only: string;
                title_bar_only: string;
            };
            styles: { display_icon_as_text: string; plain_text: string };
        };
        titles: {
            formStyles: {
                fullscreen: string;
                fullscreen_status_bar: string;
                general: string;
                general_status_bar: string;
                gridMenu: string;
                gridMenu_status_bar: string;
                medium: string;
                medium_status_bar: string;
                wide: string;
                wide_status_bar: string;
            };
            options: { removeXButton: string };
        };
    }

    Styles for ActionFormData UIs.

    • buttons: {
          options: { disabled: string; hidden: string; startSelected: string };
          positions: {
              left_side_only: string;
              main_only: string;
              right_side_only: string;
              status_bar_left_only: string;
              status_bar_only: string;
              status_bar_right_only: string;
              title_bar_only: string;
          };
          styles: { display_icon_as_text: string; plain_text: string };
      }
      • options: { disabled: string; hidden: string; startSelected: string }
        • disabled: string

          Makes the button unable to be clicked. Also makes the button display grayed out.

        • hidden: string

          Makes the button hidden.

        • startSelected: string

          Makes the button selected by default.

      • positions: {
            left_side_only: string;
            main_only: string;
            right_side_only: string;
            status_bar_left_only: string;
            status_bar_only: string;
            status_bar_right_only: string;
            title_bar_only: string;
        }

        The position of the button.

        Default

        main_only
        • left_side_only: string

          Makes the button only appear on the left side.

          Effects on different form styles:

          Grid Menu, Grid Menu (Status Bar):

          Only appears on the left side of the dialog box.

          Wide, Wide (Status Bar), Fullscreen, Fullscreen (Status Bar), Vanilla:

          No Effect.

        • main_only: string

          Makes the button only appear on the main area.

          Effects on different form styles:

          Grid Menu, Grid Menu (Status Bar):

          Only appears in the button grid.

          Wide, Wide (Status Bar), Fullscreen, Fullscreen (Status Bar), Vanilla:

          No Effect.

        • right_side_only: string

          Makes the button only appear on the right side.

          Effects on different form styles:

          Grid Menu, Grid Menu (Status Bar):

          Only appears on the right side of the dialog box.

          Wide, Wide (Status Bar), Fullscreen, Fullscreen (Status Bar), Vanilla:

          No Effect.

        • status_bar_left_only: string

          Makes the button only appear on the left side of the status bar.

          Effects on different form styles:

          Grid Menu (Status Bar), Wide (Status Bar), Fullscreen (Status Bar):

          Only appears on the left side of the status bar.

          Grid Menu, Wide, Fullscreen, Vanilla:

          No Effect.

          Deprecated

          This button position is useless because all of the form styles that have a status bar are disabled for performance reasons.

        • status_bar_only: string

          Makes the button only appear on the side of the status bar.

          Effects on different form styles:

          Grid Menu (Status Bar), Wide (Status Bar), Fullscreen (Status Bar):

          Only appears on the side of the status bar.

          Grid Menu, Wide, Fullscreen, Vanilla:

          No Effect.

          Deprecated

          This button position is useless because all of the form styles that have a status bar are disabled for performance reasons.

        • status_bar_right_only: string

          Makes the button only appear on the right side of the status bar.

          Effects on different form styles:

          Grid Menu (Status Bar), Wide (Status Bar), Fullscreen (Status Bar):

          Only appears on the right side of the status bar.

          Grid Menu, Wide, Fullscreen, Vanilla:

          No Effect.

          Deprecated

          This button position is useless because all of the form styles that have a status bar are disabled for performance reasons.

        • title_bar_only: string

          Makes the button only appear on the title bar.

      • styles: { display_icon_as_text: string; plain_text: string }
        • display_icon_as_text: string

          Makes the button's icon display as plain text.

          Todo

          Currently only works on the grid menu form.

        • plain_text: string

          Makes the button display as plain text, will also make the button unable to be clicked.

          Todo

          Currently only works on the status bar of the grid menu form.

    • titles: {
          formStyles: {
              fullscreen: string;
              fullscreen_status_bar: string;
              general: string;
              general_status_bar: string;
              gridMenu: string;
              gridMenu_status_bar: string;
              medium: string;
              medium_status_bar: string;
              wide: string;
              wide_status_bar: string;
          };
          options: { removeXButton: string };
      }
      • formStyles: {
            fullscreen: string;
            fullscreen_status_bar: string;
            general: string;
            general_status_bar: string;
            gridMenu: string;
            gridMenu_status_bar: string;
            medium: string;
            medium_status_bar: string;
            wide: string;
            wide_status_bar: string;
        }
        • fullscreen: string

          Fullscreen custom form style.

          • Allows for buttons in the title bar.
          • Is fullscreen.
        • fullscreen_status_bar: string

          Fullscreen custom form style, with a status bar.

          • Allows for buttons in the title bar.
          • Is fullscreen.
          • Has a status bar.

          Deprecated

          This form style is currently disabled for performance reasons.

        • general: string

          General custom form style.

          • Allows for buttons in the title bar.
        • general_status_bar: string

          General custom form style, with a status bar.

          • Allows for buttons in the title bar.
          • Has a status bar.

          Deprecated

          This form style is currently disabled for performance reasons.

        • gridMenu: string

          Grid menu custom form style.

          • Allows for buttons in the title bar.
          • Buttons are displayed in a grid with 3 columns.
          • Allows for buttons to the left and right of the form.
          • The form is 345px*230px instead of 220px*200px.
        • gridMenu_status_bar: string

          Grid menu custom form style, with a status bar.

          • Allows for buttons in the title bar.
          • Buttons are displayed in a grid with 3 columns.
          • Allows for buttons to the left and right of the form.
          • The form is 345px*230px instead of 220px*200px.
          • Has a status bar.

          Deprecated

          This form style is currently disabled for performance reasons.

        • medium: string

          Medium custom form style.

          This is the same as the general form style, but it is the same size as the grid menu form style.

          • Allows for buttons in the title bar.
          • The form is 345px*230px instead of 220px*200px.
        • medium_status_bar: string

          Medium custom form style, with a status bar.

          This is the same as the general (Status Bar) form style, but it is the same size as the grid menu form style.

          • Allows for buttons in the title bar.
          • The form is 345px*230px instead of 220px*200px.
          • Has a status bar.

          Deprecated

          This form style is currently disabled for performance reasons.

        • wide: string

          Wide custom form style.

          This is the same as the general form style, but is double the width.

          • Allows for buttons in the title bar.
          • Is 440px wide instead of 220px.
        • wide_status_bar: string

          Wide custom form style, with a status bar.

          This is the same as the general (Status Bar) form style, but is double the width.

          • Allows for buttons in the title bar.
          • Is 440px wide instead of 220px.
          • Has a status bar.

          Deprecated

          This form style is currently disabled for performance reasons.

      • options: { removeXButton: string }
        • removeXButton: string

          Removes the X button from the top right corner.

  • modal: {
        titles: {
            formStyles: {
                fullscreen: string;
                general: string;
                medium: string;
                wide: string;
            };
            options: { removeXButton: string };
        };
    }

    Styles for ModalFormData UIs.

Settings

Member Visibility

On This Page

Effects on different form styles:Effects on different form styles:Effects on different form styles:Effects on different form styles:Effects on different form styles:Effects on different form styles: