The document describes how text attributes can be set and queried using the textmodel::set_attr and textmodel::get_attr functions.

InDesign® knows an almost unbelievable number of attributes for text design. There is actually nothing that does not exist. With the all-rounders textmodel::set_attr and textmodel::get_attr (almost) all of these attributes can be edited. You only need to specify three things:

1. The text to change, i.e. the text frame and the index
2. Text text attribute
3. The parameters of the attributes

The most difficult part of the job is finding the right attribute to a text property. In the C++ interface to InDesign®, these attributes are called Boss Classes. We have deliberately used the same names :

• First of all, the names of the boss classes are quite self-explanatory.
• And secondly, an Internet search for the Boss classes will probably yield more concrete results than, for example, "Set InDesign® Font".

So if you don't know the corresponding attribute for a text property, you have to search: First by name, then everywhere. If you remain unsuccessful (but please only then!), you are also welcome to contact us.

Unfortunately, there is no complete documentation from Adobe about all supported text attributes and their values. The table of text attributes is the result of long and patient searching in various (sometimes very old) sources. If you find any errors or discover additional text attributes, we would be very happy if you send us a short message to paul@priint.com.

If you find a text attribute boss class that is not included in the following text attribute table, you cannot use this class directly The plug-ins will not know this boss class! And it is also not enough to enter the so-called ClassID, which you may find for the Boss class, as a number! From the boss class to the document it is still a bit to run - and we have to do that. So here too: Mail to paul@priint.com.

CJK stands for Chinese/Japanese/Korean. A large number of the text attributes are only applicable in these writing systems. In latin texts, there is simply noTate-chu-yoko. For CJK attributes, the texts may have to be vertically aligned, but in any case they must be set with a Japanese composer. Otherwise your attribute has no effect.

You do not need a special version of InDesign® to use CJK Attributes. Nor does your version need to be localized accordingly. Every InDesign® can set and apply the attributes. Only some panles are missing.

In the Table of Text Attributes, the CJK Attributes are located in the lower part of the table and are displayed in slanted font.

A few attributes are not implemented. These attributes are marked with n/a in theTable of Text Attributes.

Text attributes have of course different parameters. The attribute parameters always start with the fifth function parameter, i.e. directly after the Boss class. In the table of text attributes, the necessary parameters and their types are specified in the Parameter column. Make absolutely sure to always use the correct data types. Incorrect values or value types can cause InDesign® to crash!

Setting and querying the values usually have the same parameter types.

BUT! When fetching the values, you must pass a pointer to a variable! And please keep in mind: char* and String are already pointers but int and float Variables need the address operator &.

In the example, the font and font size of the beginning of the text are determined and placed in the current text selection.

int     fontsize;
char	fontname [512];

textmodel::get_attr (gFrame, 0, 0, kTextAttrFontUIDBoss, fontname);
textmodel::get_attr (gFrame, 0, 0, kTextAttrPointSizeBoss, &fontsize);

textmodel::set_attr (gFrame, kSelection, 0, kTextAttrFontUIDBoss, fontname);
textmodel::set_attr (gFrame, kSelection, 0, kTextAttrPointSizeBoss, fontsize);

Colors can be specified by by their swatch names or by their color values. In addition, you still need the additional information about the color space when fetching the color. Color attributes expect the following parameter.

Up to four parameters are expected. The first parameter must always be a string (char*). If this string is non-empty, it designates the Swatch to be used. If the string is empty or 0, either three int numbers with the RGB (0-255) or four float numbers with the CMYK values (0.0-1.0) of the color can follow. Lab colors are not supported by us at this time. So you have one of the three possibilities:

• char* : If the first parameter is not empty, the Swatch is used
• 0, int, int, int : RGB color ( 0-255 each)
• 0, float, float, float, float : CMYK ( 0.0 - 1.0 each)

The following three calls, provided that the color field "Orange" is defined correctly, will color the current text selection orange.

textmodel::set_attr (gFrame, kSelection, 0, kTextAttrColorBoss, "Orange");
textmodel::set_attr (gFrame, kSelection, 0, kTextAttrColorBoss, "", 255, 128, 0);
textmodel::set_attr (gFrame, kSelection, 0, kTextAttrColorBoss, "", 0.0, 0.61, 0.94, 0.0);

When querying colors, up to seven parameters can be passed :

    1.    char* - Swatch name
    2.    int*  - Color space (5 : RGB, 6 : CMYK, 7 : Lab)
    3.-6. float*, float*, float*, float* - Color components (RGB 0.0-255.0, CMYK 0.0-1.0)
    7.    int*  - Process color (or spot) (0 | 1)

Any of the parameters may be 0, but if it is not 0, it must be of the specified type.

You can use the preserved values at RGB again for setting. Note, however, that you've got float values. To convert them int o int values use the toint function.

Write the current font color into the log. Note the & (and that there is no & before colname)!

#include "internal/text.h"
#include "internal/textattributes.h"

int main ()
{
	int			len;
	char		colname [512];
	int			colspace, isProcess;
	float		c1, c2, c3, c4;
	
	textmodel::get_attr (gFrame, kSelection, &len, kTextAttrColorBoss,
	colname, &colspace, &c1, &c2, &c3, &c4, &isProcess);

	wlog ("", "color for next %d letters : '%s', %d [%f %f %f %f], %d\n", len,
	colname, colspace, c1, c2, c3, c4, isProcess);
				
	return 0;
}

The following table shows all supported line types for underlining, etc. .

The following list contains all languages and dialects available in InDesign® 2021, on the left the name used in the UI, on the right the internally used names. The spaces between : and dialect are important!

Set an own kenten 'A' with defined font and color to the current text selection

#include "internal/text.h"
#include "internal/textattributes.h"  // text attribute bosses

int main ()
{
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenKindBoss, 11);					// Custom
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenCharacterBoss, 65); 			// Letter A
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenCharacterSetBoss, 0); 			// ShiftJIS
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenColorBoss, "", 255, 128, 0); 	// Orange (RGB)
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenFontFamilyBoss, "Geogrotesque");
	textmodel::set_attr (gFrame, kSelection, 0, kTAKentenFontStyleBoss, "SemiBold Italic");
	
	return 0;
}

Toggle capital mode

#include "internal/text.h"
#include "internal/textattributes.h"  // text attribute bosses

int main ()
{
	int			al;
	
	textmodel::get_attr (gFrame, kSelection, 0, kTextAttrCapitalModeBoss, &al);
	wlog ("", "aaa-a %d\n", al);
	
	al++;
	if (al > 3) al = 0;
	textmodel::set_attr (gFrame, kSelection, 0, kTextAttrCapitalModeBoss, al);
		
	textmodel::get_attr (gFrame, kSelection, 0, kTextAttrCapitalModeBoss, &al);	
	wlog ("", "aaa-b %d\n", al);

	return 0;
}

The following table contains all supported about 250 text attributes. Default values, if present and not equal to 0, are highlighted in bold. The Workspace indicates whether an attribute is a paragraph or a character property. CJK attributes start hier.

The attribute names and their values correspond to the definitions used until InDesign^® 2024 (v19). However, Adobe reserves the right to change these definitions at any time. Changed values will cause errors in the evaluation.

In the parameter description, we have provided the description available from the Adobe documentation in each case. If you have further questions, please contact the Adobe Support directly. We do not have any further information here either.