sketchup-api-stubs 0.7.8 → 0.7.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +151 -148
- data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -523
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -693
- data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
- data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -698
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -516
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -692
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -619
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -426
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1205
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -272
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -937
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -407
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -326
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1651
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -477
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -260
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -837
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1317
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1377 -1360
- data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -389
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -496
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -635
- data/lib/sketchup-api-stubs/stubs/UI.rb +683 -683
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +10 -7
@@ -1,698 +1,747 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# References an auto-text definition. Some auto-text definitions are mandatory.
|
5
|
-
# Mandatory auto-text definitions may not be removed, added, or modified.
|
6
|
-
#
|
7
|
-
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
8
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
9
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
10
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
11
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
12
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
13
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
14
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
15
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
16
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
17
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
18
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
19
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
20
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
21
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
22
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
23
|
-
#
|
24
|
-
# @example
|
25
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
26
|
-
# definitions = doc.auto_text_definitions
|
27
|
-
# definitions.each { |auto_text|
|
28
|
-
# definitions.remove(auto_text) unless auto_text.mandatory?
|
29
|
-
# }
|
30
|
-
#
|
31
|
-
# @version LayOut 2018
|
32
|
-
class Layout::AutoTextDefinition
|
33
|
-
|
34
|
-
# Constants
|
35
|
-
|
36
|
-
NUMBER_STYLE_ARABIC = nil # Stub value.
|
37
|
-
NUMBER_STYLE_ARABIC_PADDED = nil # Stub value.
|
38
|
-
NUMBER_STYLE_LC_ALPHA = nil # Stub value.
|
39
|
-
NUMBER_STYLE_LC_ROMAN = nil # Stub value.
|
40
|
-
NUMBER_STYLE_UC_ALPHA = nil # Stub value.
|
41
|
-
NUMBER_STYLE_UC_ROMAN = nil # Stub value.
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
#
|
73
|
-
|
74
|
-
|
75
|
-
#
|
76
|
-
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
# @
|
103
|
-
#
|
104
|
-
#
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
# @raise [
|
122
|
-
#
|
123
|
-
#
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# @
|
139
|
-
#
|
140
|
-
#
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
# @raise [
|
158
|
-
#
|
159
|
-
#
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
# @
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
# @
|
194
|
-
#
|
195
|
-
#
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
#
|
213
|
-
# @
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
# @
|
230
|
-
#
|
231
|
-
#
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
# @
|
249
|
-
#
|
250
|
-
#
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
# page_count_def
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
# @
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
# @
|
288
|
-
#
|
289
|
-
#
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
# @
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
# [+Layout::AutoTextDefinition::
|
319
|
-
# [+Layout::AutoTextDefinition::
|
320
|
-
# [+Layout::AutoTextDefinition::
|
321
|
-
# [+Layout::AutoTextDefinition::
|
322
|
-
# [+Layout::AutoTextDefinition::
|
323
|
-
# [+Layout::AutoTextDefinition::
|
324
|
-
# [+Layout::AutoTextDefinition::
|
325
|
-
# [+Layout::AutoTextDefinition::
|
326
|
-
# [+Layout::AutoTextDefinition::
|
327
|
-
# [+Layout::AutoTextDefinition::
|
328
|
-
# [+Layout::AutoTextDefinition::
|
329
|
-
# [+Layout::AutoTextDefinition::
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
# @raise [ArgumentError] if name
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
# [+Layout::AutoTextDefinition::
|
389
|
-
# [+Layout::AutoTextDefinition::
|
390
|
-
# [+Layout::AutoTextDefinition::
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
# [+Layout::AutoTextDefinition::
|
418
|
-
# [+Layout::AutoTextDefinition::
|
419
|
-
# [+Layout::AutoTextDefinition::
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
# The
|
443
|
-
#
|
444
|
-
#
|
445
|
-
#
|
446
|
-
# [+Layout::AutoTextDefinition::
|
447
|
-
# [+Layout::AutoTextDefinition::
|
448
|
-
# [+Layout::AutoTextDefinition::
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
# @
|
463
|
-
#
|
464
|
-
#
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
# The
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
# [+Layout::AutoTextDefinition::
|
476
|
-
# [+Layout::AutoTextDefinition::
|
477
|
-
# [+Layout::AutoTextDefinition::
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# @raise [ArgumentError] if
|
495
|
-
#
|
496
|
-
#
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
# @
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
# @
|
531
|
-
#
|
532
|
-
#
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
# @raise [
|
551
|
-
#
|
552
|
-
#
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
# @
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
#
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
# @
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
# doc.
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
# +Layout::AutoTextDefinition::
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
# @
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
# +Layout::AutoTextDefinition::
|
640
|
-
#
|
641
|
-
#
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
650
|
-
#
|
651
|
-
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
# [
|
662
|
-
#
|
663
|
-
# [
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
# [
|
668
|
-
#
|
669
|
-
#
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
# [
|
685
|
-
#
|
686
|
-
#
|
687
|
-
#
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
#
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# References an auto-text definition. Some auto-text definitions are mandatory.
|
5
|
+
# Mandatory auto-text definitions may not be removed, added, or modified.
|
6
|
+
#
|
7
|
+
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
8
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
9
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
10
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
11
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
12
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
13
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
14
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
15
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
16
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
17
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
18
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
19
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
20
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
21
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
22
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
23
|
+
#
|
24
|
+
# @example
|
25
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
26
|
+
# definitions = doc.auto_text_definitions
|
27
|
+
# definitions.each { |auto_text|
|
28
|
+
# definitions.remove(auto_text) unless auto_text.mandatory?
|
29
|
+
# }
|
30
|
+
#
|
31
|
+
# @version LayOut 2018
|
32
|
+
class Layout::AutoTextDefinition
|
33
|
+
|
34
|
+
# Constants
|
35
|
+
|
36
|
+
NUMBER_STYLE_ARABIC = nil # Stub value.
|
37
|
+
NUMBER_STYLE_ARABIC_PADDED = nil # Stub value.
|
38
|
+
NUMBER_STYLE_LC_ALPHA = nil # Stub value.
|
39
|
+
NUMBER_STYLE_LC_ROMAN = nil # Stub value.
|
40
|
+
NUMBER_STYLE_UC_ALPHA = nil # Stub value.
|
41
|
+
NUMBER_STYLE_UC_ROMAN = nil # Stub value.
|
42
|
+
|
43
|
+
SEQUENCE_TYPE_PER_DOCUMENT = nil # Stub value.
|
44
|
+
SEQUENCE_TYPE_PER_PAGE = nil # Stub value.
|
45
|
+
|
46
|
+
TYPE_CUSTOM_TEXT = nil # Stub value.
|
47
|
+
TYPE_DATE_CREATED = nil # Stub value.
|
48
|
+
TYPE_DATE_CURRENT = nil # Stub value.
|
49
|
+
TYPE_DATE_MODIFIED = nil # Stub value.
|
50
|
+
TYPE_DATE_PUBLISHED = nil # Stub value.
|
51
|
+
TYPE_FILE = nil # Stub value.
|
52
|
+
TYPE_MODEL_CLASSIFIER_ATTRIBUTE = nil # Stub value.
|
53
|
+
TYPE_MODEL_COMPONENT_DEFINITION_ATTRIBUTE = nil # Stub value.
|
54
|
+
TYPE_MODEL_COMPONENT_DEFINITION_NAME = nil # Stub value.
|
55
|
+
TYPE_MODEL_COMPONENT_DESCRIPTION = nil # Stub value.
|
56
|
+
TYPE_MODEL_COMPONENT_INSTANCE_ATTRIBUTE = nil # Stub value.
|
57
|
+
TYPE_MODEL_COMPONENT_INSTANCE_NAME = nil # Stub value.
|
58
|
+
TYPE_MODEL_COORDINATES = nil # Stub value.
|
59
|
+
TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE = nil # Stub value.
|
60
|
+
TYPE_MODEL_EDGE_LENGTH = nil # Stub value.
|
61
|
+
TYPE_MODEL_FACE_AREA = nil # Stub value.
|
62
|
+
TYPE_MODEL_GROUP_NAME = nil # Stub value.
|
63
|
+
TYPE_MODEL_RATIO = nil # Stub value.
|
64
|
+
TYPE_MODEL_SCALE = nil # Stub value.
|
65
|
+
TYPE_MODEL_SCENE_DESCRIPTION = nil # Stub value.
|
66
|
+
TYPE_MODEL_SCENE_NAME = nil # Stub value.
|
67
|
+
TYPE_MODEL_SECTION_NAME = nil # Stub value.
|
68
|
+
TYPE_MODEL_SECTION_SYMBOL = nil # Stub value.
|
69
|
+
TYPE_MODEL_VOLUME = nil # Stub value.
|
70
|
+
TYPE_PAGE_COUNT = nil # Stub value.
|
71
|
+
TYPE_PAGE_NAME = nil # Stub value.
|
72
|
+
TYPE_PAGE_NUMBER = nil # Stub value.
|
73
|
+
TYPE_SEQUENCE = nil # Stub value.
|
74
|
+
|
75
|
+
# Instance Methods
|
76
|
+
|
77
|
+
# The {#==} method checks to see if the two {Layout::AutoTextDefinition}s are
|
78
|
+
# equal. This checks whether the Ruby Objects are pointing to the same internal
|
79
|
+
# object.
|
80
|
+
#
|
81
|
+
# @example
|
82
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
83
|
+
# definitions = doc.auto_text_definitions
|
84
|
+
# definitions.first == defs.last
|
85
|
+
#
|
86
|
+
# @param [Layout::AutoTextDefinition] other
|
87
|
+
#
|
88
|
+
# @return [Boolean]
|
89
|
+
#
|
90
|
+
# @version LayOut 2018
|
91
|
+
def ==(other)
|
92
|
+
end
|
93
|
+
|
94
|
+
# The {#custom_text} method returns the custom text of the
|
95
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+ {Layout::AutoTextDefinition}.
|
96
|
+
#
|
97
|
+
# @example
|
98
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
99
|
+
# definitions = doc.auto_text_definitions
|
100
|
+
# text = definitions.last.custom_text
|
101
|
+
#
|
102
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
103
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+
|
104
|
+
#
|
105
|
+
# @return [String]
|
106
|
+
#
|
107
|
+
# @version LayOut 2018
|
108
|
+
def custom_text
|
109
|
+
end
|
110
|
+
|
111
|
+
# The {#custom_text} method sets the custom text of the
|
112
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+ {Layout::AutoTextDefinition}.
|
113
|
+
#
|
114
|
+
# @example
|
115
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
116
|
+
# definitions = doc.auto_text_definitions
|
117
|
+
# definitions.last.custom_text = "Boop"
|
118
|
+
#
|
119
|
+
# @param [String] custom_text
|
120
|
+
#
|
121
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
122
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+
|
123
|
+
#
|
124
|
+
# @raise [TypeError] if +custom_text+ is not a String or convertable to a String.
|
125
|
+
#
|
126
|
+
# @version LayOut 2018
|
127
|
+
def custom_text=(custom_text)
|
128
|
+
end
|
129
|
+
|
130
|
+
# The {#date_format} method returns the date format of a
|
131
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+ {Layout::AutoTextDefinition}.
|
132
|
+
#
|
133
|
+
# @example
|
134
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
135
|
+
# definitions = doc.auto_text_definitions
|
136
|
+
# date_format = definitions.last.date_format
|
137
|
+
#
|
138
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
139
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+.
|
140
|
+
#
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @version LayOut 2018
|
144
|
+
def date_format
|
145
|
+
end
|
146
|
+
|
147
|
+
# The {#date_format} method sets the date format of a
|
148
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+ {Layout::AutoTextDefinition}.
|
149
|
+
#
|
150
|
+
# @example
|
151
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
152
|
+
# definitions = doc.auto_text_definitions
|
153
|
+
# definitions.last.date_format = "mmddyyyy"
|
154
|
+
#
|
155
|
+
# @param [String] date_format
|
156
|
+
#
|
157
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
158
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+.
|
159
|
+
#
|
160
|
+
# @raise [TypeError] if date_format is not a String or convertable to a String.
|
161
|
+
#
|
162
|
+
# @version LayOut 2018
|
163
|
+
def date_format=(date_format)
|
164
|
+
end
|
165
|
+
|
166
|
+
# The {#display_file_extension=} method sets whether the
|
167
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
168
|
+
# the file extension.
|
169
|
+
#
|
170
|
+
# @example
|
171
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
172
|
+
# definitions = doc.auto_text_definitions
|
173
|
+
# definitions.last.display_file_extension = false
|
174
|
+
#
|
175
|
+
# @param [Boolean] display_file_extension
|
176
|
+
#
|
177
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
178
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
179
|
+
#
|
180
|
+
# @version LayOut 2018
|
181
|
+
def display_file_extension=(display_file_extension)
|
182
|
+
end
|
183
|
+
|
184
|
+
# The {#display_file_extension?} method returns whether the
|
185
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
186
|
+
# the file extension.
|
187
|
+
#
|
188
|
+
# @example
|
189
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
190
|
+
# definitions = doc.auto_text_definitions
|
191
|
+
# show_file_extension = definitions.last.display_file_extension?
|
192
|
+
#
|
193
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
194
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
195
|
+
#
|
196
|
+
# @return [Boolean]
|
197
|
+
#
|
198
|
+
# @version LayOut 2018
|
199
|
+
def display_file_extension?
|
200
|
+
end
|
201
|
+
|
202
|
+
# The {#display_full_path=} method sets whether the
|
203
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
204
|
+
# the full path.
|
205
|
+
#
|
206
|
+
# @example
|
207
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
208
|
+
# definitions = doc.auto_text_definitions
|
209
|
+
# definitions.last.display_full_path = true
|
210
|
+
#
|
211
|
+
# @param [Boolean] display_full_path
|
212
|
+
#
|
213
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
214
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
215
|
+
#
|
216
|
+
# @version LayOut 2018
|
217
|
+
def display_full_path=(display_full_path)
|
218
|
+
end
|
219
|
+
|
220
|
+
# The {#display_full_path?} method returns whether the
|
221
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
222
|
+
# the full path.
|
223
|
+
#
|
224
|
+
# @example
|
225
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
226
|
+
# definitions = doc.auto_text_definitions
|
227
|
+
# is_full_path = definitions.last.display_full_path?
|
228
|
+
#
|
229
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
230
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
231
|
+
#
|
232
|
+
# @return [Boolean]
|
233
|
+
#
|
234
|
+
# @version LayOut 2018
|
235
|
+
def display_full_path?
|
236
|
+
end
|
237
|
+
|
238
|
+
# The {#end_page} method returns the end page for the
|
239
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
|
240
|
+
#
|
241
|
+
# @example
|
242
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
243
|
+
# page_count_def =
|
244
|
+
# doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
|
245
|
+
# # Default end_page value is nil, meaning count to the end of the document
|
246
|
+
# page = page_count_def.end_page
|
247
|
+
#
|
248
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
249
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
250
|
+
#
|
251
|
+
# @return [Layout::Page, nil]
|
252
|
+
#
|
253
|
+
# @version LayOut 2022.0
|
254
|
+
def end_page
|
255
|
+
end
|
256
|
+
|
257
|
+
# The {#end_page=} method sets the end page for the
|
258
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
|
259
|
+
#
|
260
|
+
# @example
|
261
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
262
|
+
# definitions = doc.auto_text_definitions
|
263
|
+
# page_count_def =
|
264
|
+
# doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
|
265
|
+
# # Stop the PageCount auto-text at this newly created page instead of at the end of the document
|
266
|
+
# page_count_def.end_page = doc.pages.add("new page")
|
267
|
+
#
|
268
|
+
# @param [Layout::Page, nil] page
|
269
|
+
#
|
270
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
271
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
272
|
+
#
|
273
|
+
# @version LayOut 2022.0
|
274
|
+
def end_page=(page)
|
275
|
+
end
|
276
|
+
|
277
|
+
# The {#increment} method returns the increment value for
|
278
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
279
|
+
#
|
280
|
+
# @example
|
281
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
282
|
+
# sequence_def =
|
283
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
284
|
+
# # Default sequence increment value is 1
|
285
|
+
# increment = sequence_def.increment
|
286
|
+
#
|
287
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
288
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
289
|
+
#
|
290
|
+
# @return [Integer]
|
291
|
+
#
|
292
|
+
# @version LayOut 2022.0
|
293
|
+
def increment
|
294
|
+
end
|
295
|
+
|
296
|
+
# The {#increment=} method sets the increment value for
|
297
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
298
|
+
#
|
299
|
+
# @example
|
300
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
301
|
+
# sequence_def =
|
302
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
303
|
+
# sequence_def.increment = 10
|
304
|
+
#
|
305
|
+
# @param [Integer] increment
|
306
|
+
#
|
307
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
308
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
309
|
+
#
|
310
|
+
# @version LayOut 2022.0
|
311
|
+
def increment=(increment)
|
312
|
+
end
|
313
|
+
|
314
|
+
# The {#mandatory?} method returns whether the {Layout::AutoTextDefinition} is
|
315
|
+
# mandatory or not.
|
316
|
+
#
|
317
|
+
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
318
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
319
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
320
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
321
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
322
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
323
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
324
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
325
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
326
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
327
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
328
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
329
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
330
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
331
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
332
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
333
|
+
#
|
334
|
+
# @example
|
335
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
336
|
+
# definitions = doc.auto_text_definitions
|
337
|
+
# definitions.each { |auto_text|
|
338
|
+
# definitions.remove(auto_text) unless auto_text.mandatory?
|
339
|
+
# }
|
340
|
+
#
|
341
|
+
# @return [Boolean]
|
342
|
+
#
|
343
|
+
# @version LayOut 2018
|
344
|
+
def mandatory?
|
345
|
+
end
|
346
|
+
|
347
|
+
# The {#name} method returns the name of the {Layout::AutoTextDefinition}.
|
348
|
+
#
|
349
|
+
# @example
|
350
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
351
|
+
# definitions = doc.auto_text_definitions
|
352
|
+
# name = definitions.first.name
|
353
|
+
#
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @version LayOut 2018
|
357
|
+
def name
|
358
|
+
end
|
359
|
+
|
360
|
+
# The {#name=} method sets the name of the {Layout::AutoTextDefinition}.
|
361
|
+
#
|
362
|
+
# @example
|
363
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
364
|
+
# definitions = doc.auto_text_definitions
|
365
|
+
# definitions.last.name = "New Name"
|
366
|
+
#
|
367
|
+
# @param [String] name
|
368
|
+
#
|
369
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition} is a mandatory type
|
370
|
+
#
|
371
|
+
# @raise [ArgumentError] if name matches an existing
|
372
|
+
# {Layout::AutoTextDefinition}
|
373
|
+
#
|
374
|
+
# @raise [ArgumentError] if name is an empty string
|
375
|
+
#
|
376
|
+
# @raise [TypeError] if name is not a String or convertable to a String.
|
377
|
+
#
|
378
|
+
# @version LayOut 2018
|
379
|
+
def name=(name)
|
380
|
+
end
|
381
|
+
|
382
|
+
# The {#number_style} method returns the numbering style for
|
383
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
384
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
385
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
386
|
+
#
|
387
|
+
# The numbering style can be one of the following values:
|
388
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
389
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
390
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
391
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
392
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
393
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
394
|
+
#
|
395
|
+
# @example
|
396
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
397
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
398
|
+
# number_style = sequence_def.number_style
|
399
|
+
#
|
400
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
401
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
402
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
403
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
404
|
+
#
|
405
|
+
# @return [Integer]
|
406
|
+
#
|
407
|
+
# @version LayOut 2022.0
|
408
|
+
def number_style
|
409
|
+
end
|
410
|
+
|
411
|
+
# The {#number_style=} method sets the numbering style for
|
412
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
413
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
414
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
415
|
+
#
|
416
|
+
# The numbering style can be one of the following values:
|
417
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
418
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
419
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
420
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
421
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
422
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
423
|
+
#
|
424
|
+
# @example
|
425
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
426
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
427
|
+
# sequence_def.number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
|
428
|
+
#
|
429
|
+
# @param [Integer] number_style
|
430
|
+
#
|
431
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
432
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
433
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
434
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
435
|
+
#
|
436
|
+
# @raise [ArgumentError] if number_style is not a valid page numbering style
|
437
|
+
#
|
438
|
+
# @version LayOut 2022.0
|
439
|
+
def number_style=(number_style)
|
440
|
+
end
|
441
|
+
|
442
|
+
# The {#page_number_style} method returns the numbering style for
|
443
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
|
444
|
+
#
|
445
|
+
# The numbering style can be one of the following values:
|
446
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
447
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
448
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
449
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
450
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
451
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
452
|
+
#
|
453
|
+
# @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style}
|
454
|
+
# method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
|
455
|
+
# +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
456
|
+
#
|
457
|
+
# @example
|
458
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
459
|
+
# page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
|
460
|
+
# Layout::AutoTextDefinition::TYPE_PAGE_NUMBER) number_style = page_number_def.number_style
|
461
|
+
#
|
462
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
463
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
|
464
|
+
#
|
465
|
+
# @return [Integer]
|
466
|
+
#
|
467
|
+
# @version LayOut 2018
|
468
|
+
def page_number_style
|
469
|
+
end
|
470
|
+
|
471
|
+
# The {#page_number_style=} method sets the numbering style for
|
472
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
|
473
|
+
#
|
474
|
+
# The numbering style can be one of the following values:
|
475
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
476
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
477
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
478
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
479
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
480
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
481
|
+
#
|
482
|
+
# @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style=}
|
483
|
+
# method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
|
484
|
+
# +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
485
|
+
#
|
486
|
+
# @example
|
487
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
488
|
+
# page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
|
489
|
+
# Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
490
|
+
# page_number_def.page_number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
|
491
|
+
#
|
492
|
+
# @param [Integer] number_style
|
493
|
+
#
|
494
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
495
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
|
496
|
+
#
|
497
|
+
# @raise [ArgumentError] if +number_style+ is not a valid page numbering style
|
498
|
+
#
|
499
|
+
# @version LayOut 2018
|
500
|
+
def page_number_style=(number_style)
|
501
|
+
end
|
502
|
+
|
503
|
+
# The {#renumber} method iterates through all uses of the
|
504
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition} and eliminates gaps and
|
505
|
+
# duplicates in the sequence.
|
506
|
+
#
|
507
|
+
# @example
|
508
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
509
|
+
# sequence_def =
|
510
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
511
|
+
# sequence_def.renumber
|
512
|
+
#
|
513
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
514
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
515
|
+
#
|
516
|
+
# @version LayOut 2022.0
|
517
|
+
def renumber
|
518
|
+
end
|
519
|
+
|
520
|
+
# The {#sequence_format} method returns the sequence format of a
|
521
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
|
522
|
+
#
|
523
|
+
# @example
|
524
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
525
|
+
# sequence_def =
|
526
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
527
|
+
# # Default sequence format is ###, meaning entirely replace the string with the sequence number
|
528
|
+
# sequence = sequence_def.sequence
|
529
|
+
#
|
530
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
531
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
532
|
+
#
|
533
|
+
# @return [String]
|
534
|
+
#
|
535
|
+
# @version LayOut 2022.0
|
536
|
+
def sequence_format
|
537
|
+
end
|
538
|
+
|
539
|
+
# The {#sequence_format=} method sets the sequence format of a
|
540
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
|
541
|
+
#
|
542
|
+
# @example
|
543
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
544
|
+
# sequence_def =
|
545
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
546
|
+
# sequence_def.sequence = "Figure ###"
|
547
|
+
#
|
548
|
+
# @param [String] sequence_format
|
549
|
+
#
|
550
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
551
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
552
|
+
#
|
553
|
+
# @raise [TypeError] if +sequence_format+ is not a String or convertable to a String.
|
554
|
+
#
|
555
|
+
# @version LayOut 2022.0
|
556
|
+
def sequence_format=(sequence_format)
|
557
|
+
end
|
558
|
+
|
559
|
+
# The {#sequence_type} method returns how the +Layout::AutoTextDefinition::TYPE_SEQUENCE+
|
560
|
+
# {Layout::AutoTextDefinition} operates over multiple pages in a document.
|
561
|
+
#
|
562
|
+
# The sequence type can be one of the following values:
|
563
|
+
# [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_DOCUMENT+]
|
564
|
+
# [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE+]
|
565
|
+
#
|
566
|
+
# @example
|
567
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
568
|
+
# sequence_def =
|
569
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
570
|
+
# type = sequence_def.sequence_type
|
571
|
+
#
|
572
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
573
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
574
|
+
#
|
575
|
+
# @return [Integer]
|
576
|
+
#
|
577
|
+
# @version LayOut 2023.0
|
578
|
+
def sequence_type
|
579
|
+
end
|
580
|
+
|
581
|
+
# The {#sequence_type=} method sets how the +Layout::AutoTextDefinition::TYPE_SEQUENCE+
|
582
|
+
# {Layout::AutoTextDefinition} operates over multiple pages in a document.
|
583
|
+
#
|
584
|
+
# The sequence type can be one of the following values:
|
585
|
+
# [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_DOCUMENT+]
|
586
|
+
# [+Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE+]
|
587
|
+
#
|
588
|
+
# @example
|
589
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
590
|
+
# sequence_def =
|
591
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
592
|
+
# sequence_def.sequence_type = Layout::AutoTextDefinition::SEQUENCE_TYPE_PER_PAGE
|
593
|
+
#
|
594
|
+
# @param [Integer] sequence_type
|
595
|
+
#
|
596
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
597
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
598
|
+
#
|
599
|
+
# @raise [ArgumentError] if sequence_type is not a valid sequence type
|
600
|
+
#
|
601
|
+
# @version LayOut 2023.0
|
602
|
+
def sequence_type=(sequence_type)
|
603
|
+
end
|
604
|
+
|
605
|
+
# The {#start_index} method returns the start index for
|
606
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
607
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
608
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
609
|
+
#
|
610
|
+
# @example
|
611
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
612
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
613
|
+
# start_index = sequence_def.start_index
|
614
|
+
#
|
615
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
616
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
617
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
618
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
619
|
+
#
|
620
|
+
# @return [Integer]
|
621
|
+
#
|
622
|
+
# @version LayOut 2018
|
623
|
+
def start_index
|
624
|
+
end
|
625
|
+
|
626
|
+
# The {#start_index=} method sets the start index for
|
627
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
628
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
629
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
630
|
+
#
|
631
|
+
# @example
|
632
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
633
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
634
|
+
# sequence_def.start_index = 10
|
635
|
+
#
|
636
|
+
# @param [Integer] index
|
637
|
+
#
|
638
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
639
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
640
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
641
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
642
|
+
#
|
643
|
+
# @version LayOut 2018
|
644
|
+
def start_index=(index)
|
645
|
+
end
|
646
|
+
|
647
|
+
# The {#start_page} method returns the start page for
|
648
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
|
649
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
|
650
|
+
#
|
651
|
+
# @example
|
652
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
653
|
+
# page_number_def =
|
654
|
+
# doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
655
|
+
# # Default start page is the first page of the document. However we continue to start at that
|
656
|
+
# # page even if that page is moved.
|
657
|
+
# page = page_number_def.start_page
|
658
|
+
# p page == doc.pages[0]
|
659
|
+
# doc.pages.add('new page')
|
660
|
+
# doc.pages.reorder(doc.pages[0], 1)
|
661
|
+
# p page == doc.pages[1]
|
662
|
+
#
|
663
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
664
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
|
665
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
666
|
+
#
|
667
|
+
# @return [Layout::Page]
|
668
|
+
#
|
669
|
+
# @version LayOut 2022.0
|
670
|
+
def start_page
|
671
|
+
end
|
672
|
+
|
673
|
+
# The {#start_page=} method sets the start page for
|
674
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
|
675
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
|
676
|
+
#
|
677
|
+
# @example
|
678
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
679
|
+
# page_number_def =
|
680
|
+
# doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
681
|
+
# # Start the PageCount auto-text on the new page
|
682
|
+
# page_number_def.start_page = doc.pages.add('new page')
|
683
|
+
#
|
684
|
+
# @param [Layout::Page] page
|
685
|
+
#
|
686
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
687
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
|
688
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
689
|
+
#
|
690
|
+
# @version LayOut 2022.0
|
691
|
+
def start_page=(page)
|
692
|
+
end
|
693
|
+
|
694
|
+
# The {#tag} method returns the tag string of the {Layout::AutoTextDefinition}.
|
695
|
+
#
|
696
|
+
# @example
|
697
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
698
|
+
# definitions = doc.auto_text_definitions
|
699
|
+
# tag = definitions.first.tag
|
700
|
+
#
|
701
|
+
# @return [String]
|
702
|
+
#
|
703
|
+
# @version LayOut 2018
|
704
|
+
def tag
|
705
|
+
end
|
706
|
+
|
707
|
+
# The {#type} method returns the type of the {Layout::AutoTextDefinition}.
|
708
|
+
#
|
709
|
+
# The type can be one of the following values:
|
710
|
+
# [+Layout::AutoTextDefinition::TYPE_FILE+]
|
711
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
|
712
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
|
713
|
+
# [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
|
714
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
|
715
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
|
716
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
|
717
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
|
718
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
719
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
720
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
721
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
722
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
723
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
724
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
725
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
726
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
727
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
728
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
729
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
730
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
731
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
732
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
733
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_COUNT+]
|
734
|
+
# [+Layout::AutoTextDefinition::TYPE_SEQUENCE+]
|
735
|
+
#
|
736
|
+
# @example
|
737
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
738
|
+
# definitions = doc.auto_text_definitions
|
739
|
+
# type = definitions.first.type
|
740
|
+
#
|
741
|
+
# @return [Integer]
|
742
|
+
#
|
743
|
+
# @version LayOut 2018
|
744
|
+
def type
|
745
|
+
end
|
746
|
+
|
747
|
+
end
|