Skip to content

8. Member functions not related to a property

Gary Criblez edited this page Feb 13, 2020 · 2 revisions

List of member functions that are not attached to a property

  • Draw ()

    • Generates the BreadCrumb by taking into account the current status for each section.
  • Export (templateName { ; templateFolderPath })

    • Allows you to create a template of your AJUI_Breadcrumb object in a JSON format file. The formula first requires the name to be associated with the template (file name). A second optional parameter allows you to specify the folder path, otherwise it will be exported to the default folder (.../Resources/AJUI_BreadCrumb_Templates/).
  • Hide ()

    • Hide the Breadcrumb.
  • ResetAllStates ()

    • Allows you to delete all exceptions.
  • ResetState (state)

    • Allows you to delete all the exceptions of a state. You must pass the constant corresponding to the state in parameter.
  • RemovePropertyException ( property; state)

    • Allows you to delete an exception related to a property. The property name is passed in the first parameter and the constant corresponding to the state in the second parameter.
  • RemovePropertyExceptions ( property)

    • Allows to delete all the exceptions related to a property for each of the states. The property name is expected in parameter.
  • RemovePropertyTypeExceptions ( property ; typeSection )

    • Allows you to delete all exceptions related to a property, but only for a defined type. The property name is expected in the first parameter and the type in the second parameter (available: standard | first | current | next | previous).
  • Show ()

    • Displays the Breadcrumb.  
  • RemoveCurrent ()

    • When using a groupedButtons model, the instance keeps the id of the selected section (“current type”). This function allows to erase the id in memory.

⚠️ Note that the Hide and Show member functions are actually wrappers of the 4D "OBJECT SET VISIBLE" method. You can use it directly if you wish.

⚠️ Concerning the member functions allowing to remove one or more exceptions, it must be understood that they will not have repercussions for the properties linked to "standard-default", because these properties are the default values and are therefore not exceptions.