IDE Window: Make ResourceString: what changed

Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		This wizard helps to convert a string constant into a resourcestring.
2	2
3	3		Place the cursor on a string constant or select the part of the constant that should be converted. Then do \<Right click\> Refactoring \\| Make Resource String.
4	4
5	5		A string constant is for example 'Some text'.
6	6
7	7		## Conversion Options
8	8
9	9		### Identifier prefix
10	10
11	11		You can create automatically a new identifier. The new identifier will start with the prefix, followed by the words of the string constant. If there is already a resourcestring with this value, the old identifier will be suggested. The IDE remembers the prefixes for each unit, so the last used prefix for the current unit is preselected first.
12	12
13	13		### Identifier length
14	14
15	15		This is the maximum length of the automatically created identifier.
16	16
17	17		### Custom identifier
18	18
19	19		Instead of using an automatically created identifier, you can specify the identifier on your own here.
20	20
21	21		### Resourcestring section
22	22
23	23		This combobox contains all available resourcestring sections of all units in scope. That means all sections of the current unit plus all sections in the interface parts of all used units.
24	24
25	25		### String with same value
26	26
27	27		This combobox contains all resourcestring identifiers with the same value as the new resourcestring. You can choose here, if you want to take one of them.
28	28
29	29		### Where to put the new identifier in the resourcestring section
30	30
31	31		If a new identifier is created, this defines where it will be added in the resourcestring section.
32	32
33	33		- Append to section - add the new identifier at the end of the section.
34	34		- Insert alphabetically - insert the identifier alphabetically.
35	35		- Insert context sensitive - search the code above and below the current code position and search for resourcestring identifiers. If it finds one, then the new identifier is added there, otherwise it is appended at the end of the section.
36	36
37	37		## String constant in source
38	38
39	39		This shows the old or current source code.
40	40
41	41		## Source preview
42	42
43	43		This is a preview, how the string constant is replaced, followed by a line of dashes and then a preview of how the resourcestring will look like.
44	44
45	45		## Examples
46	46
47	47		### Example 1: Setting the caption of a form
48	48
49	49		If you do not have already a resource string section, start one in the interface part of the unit. For example right above the 'implementation' keyword:
50	50
51	51		``` pascal
52	52
53	53		resourcestring
54	54		rsSomeText = 'Some text';
55	55		```
56	56
57	57		Add in the FormCreate event the following line:
58	58
59	59		``` pascal
60	60
61	61		Caption:='An example caption';
62	62		```
63	63
64	64		Place the cursor on the string constant, i.e. somewhere between the two '. Then do -\> \<Right click\> Refactoring \\| Make Resource String
65	65
66	66		Set in the identifier prefix 'rs' without the '. The new automatically suggested identifier will be 'rsAnExampleCaption'. The preview shows
67	67
68		-	~~` Caption:=rsAnExampleCaption;`\~~
69		-	~~` --------------------------------------------------------------------------------`\~~
70		-	~~` rsAnExampleCaption = 'An example caption' `~~
	68	+	``` pascal
	69	+	Caption:=rsAnExampleCaption;
	70	+	--------------------------------------------------------------------------------
	71	+	rsAnExampleCaption = 'An example caption'
	72	+	```
71	73
72	74		Click ok.
73	75
74	76		### Example 2 : Complex string constants
75	77
76	78		When converting a complex string expression with variables and functions, the tool will use the Format function. For instance the statement:
77	79
78	80		``` pascal
79	81
80	82		Caption:='Left='+IntToStr(Left)+' Top='+IntToStr(Top);
81	83		```
82	84
83	85		will be replaced with
84	86
85	87		``` pascal
86	88
87	89		Caption:=Format(rsLeftTop, [IntToStr(Left), IntToStr(Top)]);
88	90		```
89	91
90	92		and the new resourcestring will be
91	93
92	94		``` pascal
93	95
94	96		rsLeftTop = 'Left=%s Top=%s'
95	97		```
96	98
97	99		The Format function is defined in the SysUtils unit. If your unit uses section does not already contain it, you must add it yourself.
98	100
99	101		## See also
100	102
101	103		- [[Getting translation strings right]]
102	104
103	105		---
104	106		From the Free Pascal wiki, page "IDE Window: Make ResourceString", as it stood on 2021-10-11 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history