Index

C/C++ Functions

txTextAddFlowPlus

DT_SWORD txTextAddFlowPlus(DT_TXDOC text_doc, DT_ID_SLONG obj, DT_SLONG nr_of_areas, const DT_TX_TEXTFLOW_AREA areas[], const DT_SLONG pages[], DT_SWORD reserved)

Short Description: Add textflow areas for the text document (enhanced)

This function adds a new set of PowerDoc images (also called text flow images) to hold a text flow across linked textflow areas.

Note: This is an advanced and specialized function that can be called after txTextMakeViaPowerDocAndStream or txTextMakeViaPowerDocAndBuffer. Its primary users are developers who wish to use D-Type Unicode Text Module to embed text flow images into their D-Type Power Engine documents. In this use case scenario, the associated text document instance (text_doc) is usually short-lived while the Power Engine document (power_doc) is long-lived. With that in mind, the txTextAddFlowPlus function is rather different from, and should not be confused with txTextSetFlowPlus.

Parameters

ParameterDescription

text_doc

Handle of the associated text document instance.

obj

Index of the root Rich Text Area PowerDoc object that holds the text. This object must contain at minimum the pdTextFragmentPtr PowerDoc property.

nr_of_areas

See txTextSetFlowPlus

areas

See txTextSetFlowPlus

pages

See txTextSetFlowPlus

reserved

Reserved for future use. Must be set to 0.

Return Value

If the function was successful, the return value is 1. Otherwise, the function returns 0.

Comments

Each textflow area image can have its own independent position, size, 2D perspective transformation matrix and other parameters as defined by the DT_TX_TEXTFLOW_AREA structure.

 

Index