Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped
Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send
used by qualified names cache to determine old name after a rename
The current state of the structure: (new|attached|detached|deleted).
This structure is attached somewhere in the model. This is the "normal" state for an structure.
This structure has been deleted and should no longer be used.
This structure is detached, so that it can be attached somewhere else in the model.
This structure was just constructed and has not been added to the model yet.
In version 9.24.0: deleted In version 9.22.0: introduced
In version 9.24.0: deleted In version 9.22.0: introduced
In version 8.0.0: introduced
In version 8.0.0: introduced
In version 8.0.0: deleted
In version 8.0.0: deleted
In version 6.10.0: deleted
In version 6.10.0: deleted
Checks whether all attributes are available ATM
In version 6.10.0: deleted
In version 6.10.0: deleted
In version 6.10.0: deleted
In version 6.10.0: deleted
In version 8.0.0: deleted
In version 8.0.0: deleted
Asserts that the complete element is available, and not just its public part.
Finds the given child among the properties of this structure, returning a handle to detach it later when appropriate based on in which property is was found.
Deletes the given child from any (part) property that contained it.
Detaches the given child from any (part) property that contained it.
This model element is no longer part of the model, and can be cleaned up.
Return true if this is an abstractElement that might be referred to by some other element. If true, this element is maintained in the qualifiedNamesCache
Update local-by-name references to this structure.
If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.
Sends the appropriate attach delta to the server after this element has been attached to a new parent.
Sends the change delta in case a simple property has changed.
Sends the appropriate create delta to the server, and also sends all pending deltas, after this element has been assigned to some parent.
Sends the delete in case that we were removed from the model.
Sends the detach delta.
Update an existing (probably partial) interface with real contents received from the server.
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
Creates a deep copy of this element and its children.
Creates a deep copy of this element and its children. Also returns a map from original to new IDs.
Deletes this element from the model.
Detaches this element from the model, so that it can be attached in a different place.
Given an element id, returns the element in this abstract element with that id, otherwise null.
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
Returns all properties when this structure is loaded, otherwise just the public properties.
Should be called after deserialization / remote updates, to make sure all references are bound to their actual value.
Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.
Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.
Traverses this structure, returning immediately when visit returns something other than null.
Traverses this structure, only visiting children contained in public properties.
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent BuildingBlock element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.7.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent BuildingBlock element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'footerWidget' property of the parent DataView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.7.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'footerWidgets' property of the parent DataView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent DataView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent DataView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent DivContainer element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent DivContainer element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent GroupBox element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent GroupBox element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'leftWidget' property of the parent Header element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'leftWidgets' property of the parent Header element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'rightWidget' property of the parent Header element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'rightWidgets' property of the parent Header element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent LayoutCallArgument element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent LayoutCallArgument element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent LayoutGridColumn element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent LayoutGridColumn element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent Layout element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent Layout element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent ListViewTemplate element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent ListViewTemplate element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent ListView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent ListView element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent MasterDetailRegion element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayoutCallArgument element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.23.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'sidebarWidgets' property of the parent NativeLayoutContent element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 8.5.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent NativeLayoutContent element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'headerWidget' property of the parent nativepages.NativeLayout element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.22.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayout element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.21.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent NavigationListItem element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent NavigationListItem element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'parameterWidget' property of the parent reports.ReportPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'reportWidget' property of the parent reports.ReportPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent ScrollContainerRegion element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent ScrollContainerRegion element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent Snippet element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent Snippet element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'firstWidget' property of the parent SplitPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'firstWidgets' property of the parent SplitPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'secondWidget' property of the parent SplitPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'secondWidgets' property of the parent SplitPane element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent TabPage element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent TabPage element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent TableCell element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent TableCell element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widget' property of the parent TemplateGridContents element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent TemplateGridContents element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent VerticalFlow element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent WebLayoutContent element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher
Creates and returns a new SidebarToggleButton instance in the SDK and on the server. The new SidebarToggleButton will be automatically stored in the 'widgets' property of the parent customwidgets.WidgetValue element passed as argument.
Warning! Can only be used on models with the following Mendix meta model versions: 8.2.0 and higher
Generated using TypeDoc
See: relevant section in reference guide