<< Click here to display Table of Contents >> Navigation: Install, Configure and Administer GN4 > Configuring GN4 > Configuring Add-ins and scripts > Working with GN4 Scripts:

'Last used' values in dialog boxes between sessions

Build 1501 on 14/Nov/2017 This topic last edited on: 21/Mar/2016, at 18:34

Contents

By default, dialog boxes do not 'remember' the last used values between sessions, but restart with empty fields.

There's a mechanism to load and save last used values. You have to script it in add-ins, individually for each field and for each dialog box.

There are two parts to adjust: one in the script, and another in <objectUI. Both work together and both must be configured exactly as explained below.

In this topic you can find examples of how that is achieved in various dialog boxes.

You have to provide for loading and saving of last used values in scripting, individually for each field and each dialog box.

The method dlg.AddParameter as shown below, reads the value for the folder from the specified persistent variable, typically SystemUserOptions.<variablename>.

dlg.AddParameter("folderId", <persistent_variable>)

Important: this initialization needs to be defined before the line dlg.SetObjectType("....").

The selected value, specified in the dialog box, is saved by the below line, inserted after dlg.ShowDialog().

<persistent_variable> = dlg.FolderId

However, the above will work only:

•if the init section in the appropriate objectUI is defined accordingly, e.g. again with an example for the folder:

<xsl:if test="$pars and $pars/*/add[@key='folderId']">

<gn4:folderRef>

<xsl:attribute name="idref">

<xsl:value-of select="fn:objectIdToString($pars/*/add[@key='folderId']/@value)"/>

</xsl:attribute>

</gn4:folderRef>

</xsl:if>

•if the appropriate attribute, e.g. folderRef, in the same objectUI has the initMode defined as initMode = "Value":

<ui mode="Normal"

initMode="Value"

label="Select Folder"

labelPosition="Side">

<template kind="Tree"

refAttributes="folderParent"

displayCompletePath="true"

xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<web refColumnWidth="400"

width="200"

height="125"/>

</objectUI>

</template>

</ui>

</attribute>

In Page.vb, in the Public Overridable Function OnToolCreateNewArticle(ByVal name As String) As Integer Implements IFredEvent.OnToolCreateNewArticle, there's the handler that reads the folder either from the last used folder (if EdConfig.glbuseSectionFolder is False), or from the section folder id.

Select Case EdConfig.glbuseSectionFolder

Case False

If SystemUserOptions.T_LastNewArtFolderId <> 0 Then

dlg.AddParameter("folderId", SystemUserOptions.T_LastNewArtFolderId)

End If

Case True

Dim edition As Schema.Class.editionObj = Page.GetPageEdition

Dim Section As String = ""

Dim FoldPath As String = SectionsFind(Page.GetPageSection, edition.titleRefAttr).descriptionAttr

Dim iFolderId As Integer = EditorialLogin.Get().GetFolderIdFromPath(FoldPath)

If iFolderId < 1 Then ' section folder evaluates to invalid, try the new one (in defaultFolderRef)

iFolderId = UtilsBase.GetObjAttrValue(Page.GetPageSection, "defaultFolderRef")

If iFolderId < 1 Then

iFolderId = EditorialLogin.Get().GetFolderIdFromPath(EdConfig.glbBDefCopyFolder)

If iFolderId < 1 Then ' if evaluates to 0, it means invalid string

MsgBox(String.Format(My.Resources.IDS_InvalidSectionPath, Section), vbCritical, m_Label)

Return 0

End If

Else ' section folder path evaluates to valid, but check if there's a defaultFolderRef set

Dim iFold = UtilsBase.GetObjAttrValue(Page.GetPageSection, "defaultFolderRef")

If iFold > 0 Then iFolderId = iFold

End If

If iFolderId > 0 Then

dlg.AddParameter("folderId", iFolderId)

End If

End Select

It uses the NewArticle or the simpleNewArticle objectUI via objectUIGroups New and simpleNew.