List of overrides available - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10
  • OnConstructingControl – Based on the control type it will construct the control to use then call AddCtrlToElement.

  • OnDetermineControlToUse – Looks at the display item to determine what control to use.

  • OnDetermineReadOnlyControlToUse – Called by the above method if the display item is read-only.

  • AddCtrlToElement – Called when you add the label, textbox, combo, and so on into your display item element. All it does is add the control into the Controls collection and call PositionInElement.

  • PositionInElement – Loops around all the controls in the DisplayItemElement and resizes things accordingly. You would have to know what the base code is doing before attempting to override it. It would be useful to fine tune any resizing etc.

  • OnValidate – Called from the FormDisplayControl.OnValidate. It calls OnValidateField function.

  • OnValidateField – Calls OnValidateMandatoryField method. If the value has changed, it will call OnValidatePictureField (if it has a picture). Assuming no errors returns True; otherwise False.

  • ExtractForStoring – Part of the form saving/extract process. If the display item has changed and its visible, then it will call the method SetPropertyOrRels. If the section has a number of complex levels, then it will call SetPropertyOrRels for each complex objects. For example name and description section on Document create form, the name and description need to be stored on all document complex objects, that is, master, rev and ver.

  • SetPropertyOrRels – Handles each ScopedBy, such as RelDef, InterfaceDef, PropertyDef. It will create relationships (RelDef), add interfaces (IDef), and update/create properties. The properties code will call a method called OnSettingProperty which can be overridden.

  • OnSettingProperty – Just sets the value.

  • ExtractForQuery – Similar to ExtractForStoring except that it builds up QueryParameters by calling the SetQueryItems method.

  • SetQueryItems – Builds up query request object based on the scoped by types RelDef, InterfaceDef, PropertyDef. Calls the AddQueryProperty, AddQueryRelDef and AddQueryInterface properties.

  • OnValueChanged – Called whenever the check box, combos, dates, linklabels, text box value changes. This will be enhanced to provide better properties on the event args.

  • Public Overridable Function OnConstructingLabel(ByVal pstrText As String) As String

  • Public Overrides Function OnGetComboItems() As SPF.Client.Schema.Collection.IObjectDictionary

  • Public Overridable Sub OnModifyComboItems(ByVal pobjItems As SPF.Client.Schema.Collection.IObjectDictionary)

  • Public Overrides Function OnPopulateComboBox(ByVal pobjComboItems As System.Collections.IList, ByVal pstrDefaultValue As String, ByVal pcolItems As SPF.Client.Schema.Collection.IObjectDictionary) As Integer

  • Public Overrides Function OnPopulateComboBox(ByVal pobjComboItems As System.Collections.IList, ByVal pstrDefaultValue As String, ByVal pcolItems As SPF.Client.Schema.Collection.IObjectDictionary, ByVal pblnIgnoreDisplaySetting As Boolean) As Integer

  • Public Overridable Sub OnSettingProperty(ByVal pobjContextItem As SPF.Client.Schema.Interface.IObject, ByVal pobjInterface As SPF.Client.Schema.Model.IInterface, ByVal pobjProperty As SPF.Client.Schema.Model.Property, ByVal pstrValue As String)