TX Text Control .NET for WPF

Deprecated APIs

Topic

Code written for an older version of TX Text Control .NET for WPF can still call members that the reference now marks obsolete. They remain part of the API, but Text Control will remove them in a future version, so replace them before an upgrade or whenever you work on the code that uses them. Each obsolete member below is listed with the member that takes over its job.

What Obsolete Means

  • Still available. An obsolete member is still in the API and in the reference. Its reference page says that it will be removed in a future version, or that it is only available for compatibility. No source names the version that removes it.
  • Marked in the reference. The description of an obsolete member starts with "Obsolete".
  • Not for new code. Use the replacement in new code, and change existing code when you work on it.
  • Only shared members. Every obsolete member belongs to the document engine and mail merge, which TX Text Control .NET for WPF shares with the other .NET products. No member of the TXTextControl.WPF namespace, such as the TextControl, the ribbon tabs, the button bar, the ruler bar or the status bar, is marked obsolete.
  • One removal since 30.0. Version 33.0 removed the SerializationFormat overloads of the WPF barcode control's Load and Save methods without marking them obsolete first. Breaking Changes describes the change.

Obsolete Members

ObsoleteUse insteadObsolete since
ListFormat.CharAfterNumberListFormat.TextAfterNumber15.0
ListFormat.CharBeforeNumberListFormat.TextBeforeNumber15.0
The values CharAfterNumber and CharBeforeNumber of ListFormat.AttributeThe values TextAfterNumber and TextBeforeNumberNot stated
TextField.ShowActivatedTextField.HighlightMode and TextField.HighlightColorNot stated
The value GenerateXML of PDFImportSettingsThe value LoadEmbeddedDataNot stated
MailMerge.MergeBlocksMailMerge.Merge20.0

What Changes With Each Replacement

  • Numbered lists. CharAfterNumber and CharBeforeNumber hold a single character behind or in front of the number of a list item. TextAfterNumber and TextBeforeNumber, introduced in version 15.0, hold a string, so the text around the number can be longer than one character. Bullets and Numbered Lists shows how lists are formatted.
  • Highlighted text fields. ShowActivated turned the background of a text field gray while the input position was in the field. HighlightMode sets when a field is highlighted, and HighlightColor sets the color of the highlight. Fields, Hyperlinks, and Bookmarks describes the fields of a document.
  • PDF import. PDFImportSettings values are passed with LoadSettings.PDFImportSettings when a PDF document is loaded. With LoadEmbeddedData, LoadSettings.EmbeddedData provides the metadata, the form fields and the text coordinates of the document after loading. See PDF Import and Its Limitations.
  • Merge blocks. Since version 20.0, Merge processes the merge blocks of a template, sections that are repeated for each record, from the related tables of a data set. MergeBlocks needed an additional merge block around the whole document for the same result. The reference page of MergeBlocks doesn't mark it obsolete; the What's New documentation of version 20.0 does. Merge Blocks explains the blocks and their data.

When You Upgrade

Obsolete members keep working in version 34.0, so they don't block an upgrade. The changes that do require work are listed on Breaking Changes.

Related Pages