New value of a placeholder in ToDos panel, in Text Layout Rules and in scripts for calculating delimiter texts of a placeholder.

New value of a placeholder in ToDos panel, in Text Layout Rules and in scripts for calculating delimiter texts of a placeholder.

The variable may not be written with more than 2 GB characters.

Using gNewValue you can return the current (new) value of a placeholder to panel To Dos. gNewValue is defined in load scripts, but can only be filled in calls of the To Dos panel (the so called sync calls). Otherwise it is 0. Please note that in calls in which gNewValue is not equal to 0, no changes may be made to the document. In particular, textmodel::replace u.ä. must not be used, as the load scripts can be called again automatically - which can lead to endless loops.

Here is a very simple loading script with the support of the To Dos panel. 

int main ()
{
 	char		str[256];

 	strcpy (str, "My New Value");

 	if (gNewValue)
 	{
 		strcpy (gNewValue, str);
 		return 0;
 	}

 	textmodel::replace (str);
 	return 0;
}

[Since v3.3.1 R3609, 9. Apr 2013] The variable is also defined in Text Layout Rules. The background to this is that layout rules can change the placeholder text - for example, a currency can be automatically added to a price. If these placeholders are checked using the To Dos panel, the content in the document (with the currency symbol) will always differ from the value in the data source (without the currency symbol). The layout rule must therefore 'tell# the To Do's panel how it changes texts. For this purpose, the Layout Rules receives the current value from the data source in the variable gNewValue - and writes all changes back to it. A distinction is made between three cases:

  1. The rule/condition does not use gNewValue. In this case, the rule/condition is ignored by the To Do's panel calls and not executed. Conditions that are ignored are regarded as rejections (FALSE).

  2. The rule/condition does not change the placeholder text. Rules should be abandoned immediately in this case. Conditions are checked of course. In both cases, leave the value of gNewValue unchanged. If a rule accesses the placeholder content, get the value from gNewValue (and not from the document)!
  3. The rule changes the placeholder text. INormally, you first determine the current placeholder text in the script. Since you have already received the value in gNewValue, you don't need to do that here. The changes made are transferred to gNewValue and the rule is exited before any document changes are made.

[Since v4.3 R36180, 19. Feb 2025] In Scripts for Delimiter Texts you can fill the variable with the desired delimiter text. The content may be TaggedText. Please note that the type of the delimiter is specified in gDelimiterType in such scripts.

Here is an example script: 

#pragma plain

#include "internal/text.h"

int main ()
{
 	if (gDelimiterType == kPrefix)
     	// Growing ABC
     	strcpy (gNewValue, "%!TT<cSize:4>A<cSize:><cSize:6>B<cSize:><cSize:8>C");
 	else if (gDelimiterType == kPrefixIfEmpty)
     	// Shrinking ABC
 		strcpy (gNewValue, "%!TT<cSize:8>A<cSize:><cSize:6>B<cSize:><cSize:4>C");
 	else if (gDelimiterType == kPostfix)
 		// Shrinking CBA
 		strcpy (gNewValue, "%!TT<cSize:8>C<cSize:><cSize:6>B<cSize:><cSize:4>A");
 	else if (gDelimiterType == kPostfixIfEmpty)
 		// Growing CBA
 		strcpy (gNewValue, "%!TT<cSize:4>C<cSize:><cSize:6>B<cSize:><cSize:8>A");

 	return 0;
}

Since
Version 2.1, R 773
See Also
gOldValue

Alphabetic index HTML hierarchy of classes or Java