The txTextSetParams function sets important text document parameters. These parameters can be used to configure certain text document features.
Deprecation Notice: As of D-Type 8.0.1.3 this function is deprecated and might be removed in the future. This function has the same effect as the following code:
txTextSetNumericValue(text_doc, TX_NVAL_ENABLE_BITS, params->EnableBits); txTextSetNumericValue(text_doc, TX_NVAL_CONFIG_BITS, params->ConfigBits); if (params->Extra != DV_NULL) { DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc); pdDocSetParams(power_doc, params->Extra, 0); }
which is the same as:
txTextSetNumericValue(text_doc, TX_NVAL_ENABLE_BITS, params->EnableBits); txTextSetNumericValue(text_doc, TX_NVAL_CONFIG_BITS, params->ConfigBits); if (params->Extra != DV_NULL) { DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc); pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_ORIGIN, params->Extra->SizeOrigin); pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_SELECT, params->Extra->SizeSelect); pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_X, params->Extra->SizeClipExtendX); pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_Y, params->Extra->SizeClipExtendY); pdDocSetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_MASKING, params->Extra->CacheFlagForMasking); pdDocSetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_GLYPHS, params->Extra->CacheFlagForGlyphs); pdDocSetNumericValue(power_doc, PD_NVAL_CONTROL_GLYPHS, params->Extra->Reserved1); pdDocSetNumericValue(power_doc, PD_NVAL_CONTROL_ALGORITHMS, params->Extra->Reserved2); }
Modern applications should use txTextSetNumericValue and pdDocSetNumericValue instead.
Parameter | Description |
---|---|
text_doc |
Handle of the associated text document instance. |
params |
A valid pointer to the DT_TX_DOC_PARAMS structure. This structure contains important parameters for the specified text document. The members of this structure have the following meaning: EnableBits — Same as TX_NVAL_ENABLE_BITS in txTextSetNumericValue. ConfigBits — Same as TX_NVAL_CONFIG_BITS in txTextSetNumericValue. Extra — A pointer to the DT_PD_DOC_PARAMS structure that provides extra parameters. This parameter is optional and can be set to DV_NULL. |
reserved |
Reserved for future use. Must be set to 0. |
If successful, the return value is 1. Otherwise, the function returns 0.