You are here: COM API reference > Events > CalculateDisplayName event

CalculateDisplayName event

This event occurs when a new instance of an object is created. It allows the display name for the new object to be calculated by the extension.

Syntax

Private Function AMUIExtension_CalculateDisplayName(
          ByVal NewObject As Object,
          DefaultDisplayName As String,
          ByVal DefaultFileExtension As String,
          As Boolean) As String
Parameters
Name Description

NewObject

The newly created object.

DefaultDisplayName

The default display name generated by Meridian Enterprise.

DefaultFileExtension

The file extension for the new document. See Remarks.

Abort

Setting this argument to True will abort the creation of the new object.

Return Value

The string returned by this method will be the display name for the newly created object.

Remarks

This event will occur after the wizard has been shown. If no wizard is shown, the BeforeWizard event will still occur first. Information entered in the wizard can be used to calculate the display name.

When the new object is a document, the DefaultFileExtension argument will contain the file extension of the template used for the document. When renaming the document, this extension should be used for the new file name.

    Dim dsg As AMUIExtension
    Set dsg = Me

    Dim FileName As String
    Dim Doc As IASDocument
    Set Doc = dsg.DocumentDetails
    FileName = Doc.Property("ProjectName") & "-" & Doc.Property("DrawingNumber")
    AMUIExtension_CalculateDisplayName = FileName & DefaultFileExtension

For documents, please consider defining a naming expression in the Meridian Enterprise Configurator. The naming expression will overrule the display name calculated by the extension.


www.bluecieloecm.com