Class: Layout::AutoTextDefinition
- Inherits:
-
Object
- Object
- Layout::AutoTextDefinition
- Defined in:
- lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb
Overview
References an auto text definition. Some auto text definitions are mandatory. Mandatory auto text definitions may not be removed, added, or modified.
A mandatory AutoTextDefinition is one of the following types:
Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_VOLUME
Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA
Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH
Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES
Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE
Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE
Constant Summary collapse
- NUMBER_STYLE_ARABIC =
Constants
nil
- NUMBER_STYLE_ARABIC_PADDED =
Stub value.
nil
- NUMBER_STYLE_LC_ALPHA =
Stub value.
nil
- NUMBER_STYLE_LC_ROMAN =
Stub value.
nil
- NUMBER_STYLE_UC_ALPHA =
Stub value.
nil
- NUMBER_STYLE_UC_ROMAN =
Stub value.
nil
- TYPE_CUSTOM_TEXT =
Stub value.
nil
- TYPE_DATE_CREATED =
Stub value.
nil
- TYPE_DATE_CURRENT =
Stub value.
nil
- TYPE_DATE_MODIFIED =
Stub value.
nil
- TYPE_DATE_PUBLISHED =
Stub value.
nil
- TYPE_FILE =
Stub value.
nil
- TYPE_MODEL_CLASSIFIER_ATTRIBUTE =
Stub value.
nil
- TYPE_MODEL_COMPONENT_DEFINITION_ATTRIBUTE =
Stub value.
nil
- TYPE_MODEL_COMPONENT_DEFINITION_NAME =
Stub value.
nil
- TYPE_MODEL_COMPONENT_DESCRIPTION =
Stub value.
nil
- TYPE_MODEL_COMPONENT_INSTANCE_ATTRIBUTE =
Stub value.
nil
- TYPE_MODEL_COMPONENT_INSTANCE_NAME =
Stub value.
nil
- TYPE_MODEL_COORDINATES =
Stub value.
nil
- TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE =
Stub value.
nil
- TYPE_MODEL_EDGE_LENGTH =
Stub value.
nil
- TYPE_MODEL_FACE_AREA =
Stub value.
nil
- TYPE_MODEL_GROUP_NAME =
Stub value.
nil
- TYPE_MODEL_VOLUME =
Stub value.
nil
- TYPE_PAGE_NAME =
Stub value.
nil
- TYPE_PAGE_NUMBER =
Stub value.
nil
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
The #== method checks to see if the two AutoTextDefinitions are equal.
-
#custom_text ⇒ String
The #custom_text method returns the custom text of the
Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
AutoTextDefinition. -
#custom_text=(custom_text) ⇒ Object
The #custom_text method sets the custom text of the
Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
AutoTextDefinition. -
#date_format ⇒ String
The #date_format method returns the date format of a
Layout::AutoTextDefinition::TYPE_DATE_*
AutoTextDefinition. -
#date_format=(date_format) ⇒ Object
The #date_format method sets the date format of a
Layout::AutoTextDefinition::TYPE_DATE_*
AutoTextDefinition. -
#display_file_extension=(display_file_extension) ⇒ Object
The #display_file_extension= method sets whether the
Layout::AutoTextDefinition::TYPE_FILE
AutoTextDefinition displays the file extension. -
#display_file_extension? ⇒ Boolean
The #display_file_extension? method returns whether the
Layout::AutoTextDefinition::TYPE_FILE
AutoTextDefinition displays the file extension. -
#display_full_path=(display_full_path) ⇒ Object
The #display_full_path= method sets whether the
Layout::AutoTextDefinition::TYPE_FILE
AutoTextDefinition displays the full path. -
#display_full_path? ⇒ Boolean
The #display_full_path? method returns whether the
Layout::AutoTextDefinition::TYPE_FILE
AutoTextDefinition displays the full path. -
#mandatory? ⇒ Boolean
The #mandatory? method returns whether the AutoTextDefinition is mandatory or not.
-
#name ⇒ String
The #name method returns the name of the AutoTextDefinition.
-
#name=(name) ⇒ Object
The #name= method sets the name of the AutoTextDefinition.
-
#page_number_style ⇒ Integer
The #page_number_style method returns the numbering style for the
Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
AutoTextDefinition. -
#page_number_style=(number_style) ⇒ Object
The #page_number_style= method sets the numbering style for the
Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
AutoTextDefinition. -
#start_index ⇒ Integer
The #start_index method returns the start index for the
Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
AutoTextDefinition. -
#start_index=(index) ⇒ Object
The #start_index method returns the start index for the
Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
AutoTextDefinition. -
#tag ⇒ String
The #tag method returns the tag string of the AutoTextDefinition.
-
#type ⇒ Integer
The #type method returns the type of the AutoTextDefinition.
Instance Method Details
#==(other) ⇒ Boolean
The #== method checks to see if the two Layout::AutoTextDefinitions are equal. This checks whether the Ruby Objects are pointing to the same internal object.
75 76 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 75 def ==(other) end |
#custom_text ⇒ String
The #custom_text method returns the custom text of the Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
Layout::AutoTextDefinition.
92 93 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 92 def custom_text end |
#custom_text=(custom_text) ⇒ Object
The #custom_text method sets the custom text of the Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
Layout::AutoTextDefinition.
109 110 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 109 def custom_text=(custom_text) end |
#date_format ⇒ String
The #date_format method returns the date format of a Layout::AutoTextDefinition::TYPE_DATE_*
Layout::AutoTextDefinition.
126 127 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 126 def date_format end |
#date_format=(date_format) ⇒ Object
The #date_format method sets the date format of a Layout::AutoTextDefinition::TYPE_DATE_*
Layout::AutoTextDefinition.
143 144 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 143 def date_format=(date_format) end |
#display_file_extension=(display_file_extension) ⇒ Object
The #display_file_extension= method sets whether the Layout::AutoTextDefinition::TYPE_FILE
Layout::AutoTextDefinition displays the file extension.
161 162 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 161 def display_file_extension=(display_file_extension) end |
#display_file_extension? ⇒ Boolean
The #display_file_extension? method returns whether the Layout::AutoTextDefinition::TYPE_FILE
Layout::AutoTextDefinition displays the file extension.
179 180 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 179 def display_file_extension? end |
#display_full_path=(display_full_path) ⇒ Object
The #display_full_path= method sets whether the Layout::AutoTextDefinition::TYPE_FILE
Layout::AutoTextDefinition displays the full path.
197 198 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 197 def display_full_path=(display_full_path) end |
#display_full_path? ⇒ Boolean
The #display_full_path? method returns whether the Layout::AutoTextDefinition::TYPE_FILE
Layout::AutoTextDefinition displays the full path.
215 216 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 215 def display_full_path? end |
#mandatory? ⇒ Boolean
The #mandatory? method returns whether the Layout::AutoTextDefinition is mandatory or not.
A mandatory Layout::AutoTextDefinition is one of the following types:
Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_VOLUME
Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA
Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH
Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES
Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE
Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE
243 244 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 243 def mandatory? end |
#name ⇒ String
The #name method returns the name of the Layout::AutoTextDefinition.
256 257 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 256 def name end |
#name=(name) ⇒ Object
The #name= method sets the name of the Layout::AutoTextDefinition.
276 277 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 276 def name=(name) end |
#page_number_style ⇒ Integer
The #page_number_style method returns the numbering style for the Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
Layout::AutoTextDefinition.
The page numbering style can be one of the following values:
Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC
Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED
Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA
Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA
Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN
301 302 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 301 def page_number_style end |
#page_number_style=(number_style) ⇒ Object
The #page_number_style= method sets the numbering style for the Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
Layout::AutoTextDefinition.
The page numbering style can be one of the following values:
Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC
Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED
Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA
Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA
Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN
328 329 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 328 def page_number_style=(number_style) end |
#start_index ⇒ Integer
The #start_index method returns the start index for the Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
Layout::AutoTextDefinition.
345 346 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 345 def start_index end |
#start_index=(index) ⇒ Object
The #start_index method returns the start index for the Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
Layout::AutoTextDefinition.
362 363 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 362 def start_index=(index) end |
#tag ⇒ String
The #tag method returns the tag string of the Layout::AutoTextDefinition.
375 376 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 375 def tag end |
#type ⇒ Integer
The #type method returns the type of the Layout::AutoTextDefinition.
The type can be one of the following values:
Layout::AutoTextDefinition::TYPE_FILE
Layout::AutoTextDefinition::TYPE_PAGE_NAME
Layout::AutoTextDefinition::TYPE_PAGE_NUMBER
Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
Layout::AutoTextDefinition::TYPE_DATE_CURRENT
Layout::AutoTextDefinition::TYPE_DATE_CREATED
Layout::AutoTextDefinition::TYPE_DATE_MODIFIED
Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED
Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_VOLUME
Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA
Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH
Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES
Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE
Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE
408 409 |
# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 408 def type end |