IPFButton formatter

For the IPFButton field display formatter, you can select one of these types:

  • Button: Fires a click event.
  • Filter Button: Fires a click event and a filter changed event. This option can be applied to a button on any unbound layout and generates a filter that is passed to all the other peer layouts. All enabled fields with a non-null value are sent out in a filter. The enabled fields are added to a filter with type of property. The property name is the name of the component from the Layout Editor, the value/display value is the data in the enabled field, and the display name is the filter display name specified in the Layout Editor or, if none is specified, the component name from the Layout Editor.
    Note: If you create a filter button and set the Interactive property to True, then the button does not have to be displayed in the UI. With interactive filtering, the filter event occurs automatically when users enter data in the filter field(s), so you can hide the button if you prefer. More information is provided in the context-sensitive help in the FDF Editor.
  • Login Button: Fires click events and tries to log in to the portal with values supplied in the other fields. It specifies that this button, when clicked, will authenticate the user and start an authenticated session. The UserAuthenticated even handler is run after the user authenticates successfully.

    You can deny access from the UserAuthenticated event handler with:

    parms.AccessDenied = true

    parms.AccessDeniedMessage = "some message"

    The Click handler is executed only after authentication succeeds. If authentication fails, the click handler is not run. If the click handler does not navigate somewhere explicitly, the system automatically navigates to the original URL or the default page (whichever is applicable).

    You can get more information about what happened in the Click handler with:

    context.UnboundComponents("the login button").FieldDisplayFormatAttributes.IPFButton.LastAuthentication

    This formatter has a property named Error when the formatter is used as a login button. When this property is provided, failure messages are displayed here. If this property is not provided on the IPFButton FDF, or if the property does not exist on the layout, then the default pop-up window is displayed by the architecture.

    The login button is enabled only before the user logs in. The user must log out before the button will become enabled again.

  • Logout Button: Logs out of the portal and fires click events. If the authenticator is an external authenticator, the user is logged out of IPF but not the external authenticator.
  • External Login Button: Fires click events and attempts to log in using an external authenticator, such as Azure Active Directory (AD). The button receives the same click events as the Login Button type.

    This button is used to provide single sign-on (SSO) access to the portals. Because the user credential collection and validation is handled by an external authenticator, the portal UI does not present text boxes for users to enter credentials. If the user is already logged in, the external login button is not enabled for use. Also, if the authenticator is not external, the user is not authenticated after clicking the external login button.

  • External Logout Button: Logs out of the portal and fires click events. If the authenticator is an external authenticator, the user is logged out of IPF and the external authenticator. If the authenticator is not external, this button behaves like the Logout Button type.
  • Change Password Button: Fires click events and tries to change the password of a specified user with values supplied in the other fields. Specifies that when clicked, this button changes the password. The Click handler is executed only after ChangePassword succeeds. If ChangePassword fails, the click handler is not run. If the Click handler does not navigate somewhere explicitly, the system automatically navigates to the original URL or the default page (whichever is applicable).

The other fields, if any, that are displayed depend on your selection. For information about a specific option in the FDF Editor, click in the field to see the context-sensitive help.

All browsers support the functionality described here. There is no fallback functionality for specific browsers. This table shows how the field is displayed with and without formatting:

Before formatting After formatting
Button label:

No formatting attributes applied. Notice the background of the button fills the cell and the label is centered:

Portion of a Filter FDF with the Go button that executes the filter:

Using the Filter button. The look is the same as a button with no attributes specified:

Button for a Login page with the associated Account and Password properties displayed:

Using the Login button and displaying an error message:

Button for a Change Password page with the associated Old, New, and Confirmation password properties displayed:

Using the Change Password button and displaying an error message: