TX Text Control .NET for WPF

What's New in TX Text Control .NET for WPF 28.0

Topic

Form fields and the rules that connect them are the main addition of version 28.0, and TX Text Control .NET for WPF received a ribbon tab, dialog boxes and a sidebar for both. Document targets, the bookmarks of a document, changed their class hierarchy in this version, which can require changes to existing code.

Version 28.0 was released on March 16, 2020, as TX Text Control X18, together with TX Text Control .NET Server, TX Text Control .NET for Windows Forms and TX Text Control ActiveX. The last full installer of version 28.0 is dated October 26, 2020, shortly after Service Pack 4. The features below are the ones added since version 27.0.

Version 28.0 at a Glance

AreaWhat is new
FormsCheck box, text, selection and date form fields, saved as TX, DOC, DOCX and RTF and exported as PDF form fields
Conditional instructionsRules that enable, validate or fill form fields depending on the values of other fields, with dialog boxes and a sidebar
Document targetsBookmarks at any position, several at one position, DocumentTarget no longer derived from TextField
Dialog boxesThe measuring unit of sizes and distances in the built-in dialog boxes

Form Fields

Four new kinds of text fields let you design forms and let users fill them out. TextControl.FormFields returns the FormFieldCollection of the main text; headers, footers and text frames have their own, and ServerTextControl.FormFields does the same without a user interface. See Form Fields and Conditional Instructions and, for code without a visible control, Forms and Conditional Instructions.

Conditional Instructions

Conditional instructions are a rule engine for forms. A ConditionalInstruction holds a list of Instruction objects that are executed when its Condition objects are met. FormFieldCollection.ConditionalInstructions returns the ConditionalInstructionCollection of a document.

  • Conditions. A condition is met when the value of its form field compares successfully with a required value.
  • Instructions. An instruction does one of four things to a form field: it changes FormField.Enabled, marks the value as valid or invalid, sets a new value or replaces the Items of a selection field.
  • Else values. An instruction can have an else value, which is applied when the conditions aren't met.
  • Dialog boxes. TextControl.ManageConditionalInstructionsDialog opens a dialog box that lists the instructions of the document, and ConditionalInstructionDialog one that defines a single instruction.
  • Sidebar. The Conditional Instructions sidebar manages the instructions beside the document. RibbonFormFieldsTab.ConditionalInstructionsSidebar and ConditionalInstructionsHorizontalSidebar name the sidebars that the ribbon tab opens.
  • Protected documents. TextControl.IsFormFieldValidationEnabled sets whether conditional instructions are applied while the document is read-only and the edit mode is ReadAndSelect. The default is false.

Form Fields and Conditional Instructions shows conditional instructions at work, and Sidebar and Panels connects sidebars to the ribbon.

Document Targets and Bookmarks

A DocumentTarget is a bookmark: a position in the document that a link can point to.

  • Any position. A document target can be inserted at any text position, including inside a text field and at its beginning or end, and several targets can share one position. The built-in BookmarkDialog lets users insert several bookmarks at the same position as well.
  • No longer a text field. To make this possible, DocumentTarget no longer inherits from TextField. Members it used to inherit, such as the ID and ScrollTo, are now implemented by DocumentTarget itself, and inherited members that had no meaning for a target, such as Text and Editable, are gone.
  • Events. DocumentTargetCreated and DocumentTargetDeleted of TextControl pass a DocumentTargetEventArgs object. DocumentTargetCollection.GetItems is also new.

See Fields for links and bookmarks today.

Dialog Boxes

TextControl.DialogUnit sets the measuring unit of sizes and distances in the built-in dialog boxes. Built-in Dialog Boxes lists the dialog boxes.

Upgrade to Version 28.0

  • DocumentTarget no longer inherits from TextField. Code that treats a DocumentTarget as a TextField, casts it to one or calls a member that only TextField has, such as Text or Editable, doesn't compile against version 28.0. Use the members of DocumentTarget itself, such as TargetName.
  • TextFieldType.DocumentTarget removed. The value DocumentTarget of the TextFieldType enumeration was removed. Code that passes it has to change; the targets of the main text are in TextControl.DocumentTargets.
  • Update notes. TextFieldType was extended with CheckFormField, DateFormField, SelectionFormField, TextFormField and FormFields. LoadSettings.ApplicationFieldFormat accepts the new value MSWordTXFormFields of ApplicationFieldFormat, which loads the form fields of MS Word as form fields of TX Text Control.

New Classes, Properties, Methods and Events

These are the classes and members that the What's New documentation of version 28.0 lists for TX Text Control .NET for WPF. Names are relative to the TXTextControl namespace. Each name links to its current reference page.

New Classes

.NET Members by Class

ClassPropertiesMethodsEvents
ApplicationFieldCollectionItem
CheckFormFieldChecked, CheckedCharacter, SupportedCheckedCharacters, SupportedUncheckedCharacters, UncheckedCharacter
CheckFormFieldEventArgsCheckFormField
ConditionComparisonOperator, ComparisonValue, ComparisonValueType, FormField, LogicalConnective
ConditionalInstructionConditions, Instructions, NameCopy
ConditionalInstructionCollectionConditionalInstructionNames, CountAdd, Clear, CopyTo, GetEnumerator, GetItem, GetItems, IsValueValid, Remove
DateFormFieldDate, DateFormat, EmptyWidth, IsDateControlVisible, SupportedDateFormats
DateFormFieldEventArgsDateFormField
DocumentLinkCollectionItem
DocumentPermissionsAllowEditingFormFields
DocumentTargetCollectionItemGetItems
DocumentTargetEventArgsDocumentTarget
FormFieldEnabled
FormFieldCollectionConditionalInstructions, ItemAdd, Clear, CopyTo, GetItem, Remove
HeaderFooterFormFields
HypertextLinkCollectionItem
IFormattedTextFormFields
InstructionElseInstructionValue, FormField, InstructionType, InstructionValue, IsElseInstructionEnabled, IsFormFieldChangeInstruction, IsInitialInstruction
PageNumberFieldCollectionItem
SelectionFormFieldEmptyWidth, IsDropDownArrowVisible, Items, SelectedIndex
SelectionFormFieldEventArgsSelectionFormField
ServerTextControlFormFieldsOnDocumentTargetCreated, OnDocumentTargetDeleted, OnTextFieldCreated, OnTextFieldDeletedDocumentTargetCreated, DocumentTargetDeleted, TextFieldCreated, TextFieldDeleted
TextFieldCollectionItem
TextFormFieldEmptyWidth
TextFormFieldEventArgsTextFormField
TextFrameFormFields
WPF.RibbonFormFieldsTabConditionalInstructionsHorizontalSidebar, ConditionalInstructionsSidebar
WPF.TextControlCanEditFormFields, DialogUnit, FormFields, IsFormFieldValidationEnabled, RibbonFormFieldsTabConditionalInstructionDialog, ManageConditionalInstructionsDialog, OnDocumentTargetCreated, OnDocumentTargetDeleted, OnFormFieldCheckChanged, OnFormFieldDateChanged, OnFormFieldSelectionChanged, OnFormFieldTextChangedDocumentTargetCreated, DocumentTargetDeleted, FormFieldCheckChanged, FormFieldDateChanged, FormFieldSelectionChanged, FormFieldTextChanged
WPF.TextControlColorsActiveFormFieldColor, FormFieldColor

Next Steps