Formatting

In addition to the standard formatting features you can define script formatters. These are displayed as objects in the project script and fire an event that lets you format a field’s text to your custom format. There are three options for the type of the formatter: Date, Double, and Text. Depending on the type, a different event is fired.

A visual example of the Script Formatter Event.

Private Sub MyFormatter_FormatField(ByVal FieldText As String, FormattedText As String, ErrDescription As String, ValidFormat As Boolean)

The parameter FieldText is the field's text before the formatting is applied, whereas FormattedText contains the formatted text. Put to the parameter ErrorDescription the message that is displayed to the user in Validation. Set the flag ValidFormat to decide if the script formatting failed or not.

Private Sub Formatting_FormatDoubleField(ByVal FieldText As String, FormattedText As String, ErrDescription As String, ValidFormat As Boolean, ByRef DoubleVal As Double, ByRef DoubleFormatted As Boolean)

The parameter FieldText is the field's date before the formatting is applied, whereas FormattedText contains the formatted date. Put to the parameter ErrorDescription the message that is displayed to the user in Validation. Set the flag ValidFormat to decide if the script formatting failed or not. The DateVal parameter contains the date value of the field if the date formatting succeeded and the flag DateFormatted is reflecting if the DateVal is set.

Private Sub Formatting_FormatDateField(ByVal FieldText As String, FormattedText As String, ErrDescription As String, ValidFormat As Boolean, ByRef DateVal As Date, ByRef DateFormatted As Boolean)

The parameter FieldText is the field's double value before the formatting is applied, whereas FormattedText contains the formatted value. Put to the parameter ErrorDescription the message that is displayed to the user in Validation. Set the flag ValidFormat to decide if the script formatting failed or not. The DoubleVal parameter contains the double value of the field if the date formatting succeeded and the flag DoubleFormatted is reflecting if the DoubleVal is set.

Sometimes dates need to be formatted differently depending on the current locale. This can be done by the following script formatter, which calls other defined date formatters in its implementation.

Private Sub RegionalDateFormatter_FormatField(ByVal FieldText As String, _
         FormattedText As String, ErrDescription As String, ValidFormat As Boolean)

   Select Case Application.UILanguage

      Case "en-US"
         ValidFormat = Project.FieldFormatters.ItemByName("USDateFormatter").FormatFieldText( _
                           FieldText, FormattedText, ErrDescription)

      Case Else
         ValidFormat = Project.FieldFormatters.ItemByName("OtherDateFormatter").FormatFieldText( _
                           FieldText, FormattedText, ErrDescription)

   End Select

End Sub

The following script formatter initializes empty fields to 0.00 else it forwards the formatting task to the StandardAmountFormatter. The is especially useful for most of the additional amount fields (tax 2-4) which are in most of the cases not present on a document should therefore be set to 0.00. The same task could also be done in the Document_AfterExtract event but then you need to repair all formatting flags so that the field is properly formatted. Be aware that the invoice validation method requires that all input fields are formatted with an amount formatter. Using a script formatter makes this auto-initialization feature also available in Validation in case the user start entering values into an empty document, e.g. after splitting a document.

Private Sub EmptyAmounts_FormatDoubleField(ByVal FieldText As String, _
FormattedText As String, ErrDescription As String, ValidFormat As Boolean, _
ByRef DoubleVal As Double, ByRef DoubleFormatted As Boolean)

   Dim pfield As CscXDocField

   If Len(FieldText) = 0 Then
      ' mark the field as correctly formatted and assign the default text
      DoubleVal = 0.0
      FormattedText = "0.00"
      DoubleFormatted = True
      ValidFormat = True
   Else
      ' create a temporary field and forward the formatting to the DefaultAmountFormatter
      ' make sure that there is an amount formatter with that name available in the current project
      Set pfield = New CscXDocField
      pfield.Text = FieldText
      ValidFormat = DefaultAmountFormatter.FormatField(pfield)

      FormattedText = pfield.Text
      ErrDescription = pfield.ErrorDescription
      DoubleVal = pfield.DoubleValue
      DoubleFormatted = pfield.DoubleFormatted

   End If

End Sub

Your search for returned results.

Search tips

Formatting