Class: Layout::AutoTextDefinition

Inherits:

Object

Object
Layout::AutoTextDefinition

show all

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
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_SCALE
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.each { |auto_text|
  definitions.remove(auto_text) unless auto_text.mandatory?
}

Version:

LayOut 2018

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_RATIO = Stub value.

nil

TYPE_MODEL_SCALE = Stub value.

nil

TYPE_MODEL_SCENE_DESCRIPTION = Stub value.

nil

TYPE_MODEL_SCENE_NAME = Stub value.

nil

TYPE_MODEL_SECTION_NAME = Stub value.

nil

TYPE_MODEL_SECTION_SYMBOL = Stub value.

nil

TYPE_MODEL_VOLUME = Stub value.

nil

TYPE_PAGE_COUNT = Stub value.

nil

TYPE_PAGE_NAME = Stub value.

nil

TYPE_PAGE_NUMBER = Stub value.

nil

TYPE_SEQUENCE = 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.
#end_page ⇒ Layout::Page^?

The #end_page method returns the end page for the Layout::AutoTextDefinition::TYPE_PAGE_COUNT AutoTextDefinition.
#end_page=(page) ⇒ Object

The #end_page= method sets the end page for the Layout::AutoTextDefinition::TYPE_PAGE_COUNT AutoTextDefinition.
#increment ⇒ Integer

The #increment method returns the increment value for Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#increment=(increment) ⇒ Object

The #increment= method sets the increment value for Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#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.
#number_style ⇒ Integer

The #number_style method returns the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#number_style=(number_style) ⇒ Object

The #number_style= method sets the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#page_number_style ⇒ Integer deprecated Deprecated.

LayOut 2022.0 This method is deprecated in favor of the more generic #number_style method that also works on Layout::AutoTextDefintion::TYPE_PAGE_COUNT and Layout::AutoTextDefintion::TYPE_SEQUENCE AutoTextDefinitions.
#page_number_style=(number_style) ⇒ Object deprecated Deprecated.

LayOut 2022.0 This method is deprecated in favor of the more generic #number_style= method that also works on Layout::AutoTextDefintion::TYPE_PAGE_COUNT and Layout::AutoTextDefintion::TYPE_SEQUENCE AutoTextDefinitions.
#renumber ⇒ Object

The #renumber method iterates through all uses of the Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinition and eliminates gaps and duplicates in the sequence.
#sequence_format ⇒ String

The #sequence_format method returns the sequence format of a Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinition.
#sequence_format=(sequence_format) ⇒ Object

The #sequence_format= method sets the sequence format of a Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinition.
#start_index ⇒ Integer

The #start_index method returns the start index for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#start_index=(index) ⇒ Object

The #start_index= method sets the start index for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE AutoTextDefinitions.
#start_page ⇒ Layout::Page

The #start_page method returns the start page for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER and Layout::AutoTextDefinition::TYPE_PAGE_COUNT AutoTextDefinitions.
#start_page=(page) ⇒ Object

The #start_page= method sets the start page for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER and Layout::AutoTextDefinition::TYPE_PAGE_COUNT AutoTextDefinitions.
#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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.first == defs.last

Parameters:

other (Layout::AutoTextDefinition)

Returns:

(Boolean)

Version:

LayOut 2018



88
89

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 88

def ==(other)
end

#custom_text ⇒ `String`

The #custom_text method returns the custom text of the Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
text = definitions.last.custom_text

Returns:

(String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT

Version:

LayOut 2018



105
106

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 105

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.last.custom_text = "Boop"

Parameters:

custom_text (String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT
(TypeError) —

if custom_text is not a String or convertable to a String.

Version:

LayOut 2018



124
125

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 124

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
date_format = definitions.last.date_format

Returns:

(String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_DATE_*.

Version:

LayOut 2018



141
142

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 141

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.last.date_format = "mmddyyyy"

Parameters:

date_format (String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_DATE_*.
(TypeError) —

if date_format is not a String or convertable to a String.

Version:

LayOut 2018



160
161

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 160

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.last.display_file_extension = false

Parameters:

display_file_extension (Boolean)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_FILE.

Version:

LayOut 2018



178
179

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 178

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
show_file_extension = definitions.last.display_file_extension?

Returns:

(Boolean)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_FILE.

Version:

LayOut 2018



196
197

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 196

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.last.display_full_path = true

Parameters:

display_full_path (Boolean)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_FILE.

Version:

LayOut 2018



214
215

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 214

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.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
is_full_path = definitions.last.display_full_path?

Returns:

(Boolean)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_FILE.

Version:

LayOut 2018



232
233

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 232

def display_full_path?
end

#end_page ⇒ `Layout::Page`^?

The #end_page method returns the end page for the Layout::AutoTextDefinition::TYPE_PAGE_COUNT Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_count_def =
    doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
# Default end_page value is nil, meaning count to the end of the document
page = page_count_def.end_page

Returns:

(Layout::Page, nil)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_COUNT.

Version:

LayOut 2022.0



251
252

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 251

def end_page
end

#end_page=(page) ⇒ `Object`

The #end_page= method sets the end page for the Layout::AutoTextDefinition::TYPE_PAGE_COUNT Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
page_count_def =
    doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
# Stop the PageCount auto-text at this newly created page instead of at the end of the document
page_count_def.end_page = doc.pages.add("new page")

Parameters:

page (Layout::Page, nil)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_COUNT.

Version:

LayOut 2022.0



271
272

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 271

def end_page=(page)
end

#increment ⇒ `Integer`

The #increment method returns the increment value for Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def =
    doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
# Default sequence increment value is 1
increment = sequence_def.increment

Returns:

(Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2022.0



290
291

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 290

def increment
end

#increment=(increment) ⇒ `Object`

The #increment= method sets the increment value for Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def =
    doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
sequence_def.increment = 10

Parameters:

increment (Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2022.0



308
309

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 308

def increment=(increment)
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
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_SCALE
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.each { |auto_text|
  definitions.remove(auto_text) unless auto_text.mandatory?
}

Returns:

(Boolean)

Version:

LayOut 2018



341
342

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 341

def mandatory?
end

#name ⇒ `String`

The #name method returns the name of the Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
name = definitions.first.name

Returns:

(String)

Version:

LayOut 2018



354
355

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 354

def name
end

#name=(name) ⇒ `Object`

The #name= method sets the name of the Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
definitions.last.name = "New Name"

Parameters:

name (String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition is a mandatory type
(ArgumentError) —

if name matches an existing Layout::AutoTextDefinition
(ArgumentError) —

if name is an empty string
(TypeError) —

if name is not a String or convertable to a String.

Version:

LayOut 2018



376
377

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 376

def name=(name)
end

#number_style ⇒ `Integer`

The #number_style method returns the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

The 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

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
number_style = sequence_def.number_style

Returns:

(Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, or Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2022.0



405
406

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 405

def number_style
end

#number_style=(number_style) ⇒ `Object`

The #number_style= method sets the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

The 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

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
sequence_def.number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN

Parameters:

number_style (Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, or Layout::AutoTextDefinition::TYPE_SEQUENCE.
(ArgumentError) —

if number_style is not a valid page numbering style

Version:

LayOut 2022.0



436
437

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 436

def number_style=(number_style)
end

#page_number_style ⇒ `Integer`

Deprecated.

LayOut 2022.0 This method is deprecated in favor of the more generic #number_style method that also works on Layout::AutoTextDefintion::TYPE_PAGE_COUNT and Layout::AutoTextDefintion::TYPE_SEQUENCE Layout::AutoTextDefinitions.

The #page_number_style method returns the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER Layout::AutoTextDefinitions.

The 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

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
  Layout::AutoTextDefinition::TYPE_PAGE_NUMBER) number_style = page_number_def.number_style

Returns:

(Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER.

Version:

LayOut 2018



465
466

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 465

def page_number_style
end

#page_number_style=(number_style) ⇒ `Object`

Deprecated.

LayOut 2022.0 This method is deprecated in favor of the more generic #number_style= method that also works on Layout::AutoTextDefintion::TYPE_PAGE_COUNT and Layout::AutoTextDefintion::TYPE_SEQUENCE Layout::AutoTextDefinitions.

The #page_number_style= method sets the numbering style for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER Layout::AutoTextDefinitions.

The 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

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
  Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
page_number_def.page_number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN

Parameters:

number_style (Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER.
(ArgumentError) —

if number_style is not a valid page numbering style

Version:

LayOut 2018



497
498

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 497

def page_number_style=(number_style)
end

#renumber ⇒ `Object`

The #renumber method iterates through all uses of the Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinition and eliminates gaps and duplicates in the sequence.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def =
    doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
sequence_def.renumber

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2022.0



514
515

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 514

def renumber
end

#sequence_format ⇒ `String`

The #sequence_format method returns the sequence format of a Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def =
    doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
# Default sequence format is ###, meaning entirely replace the string with the sequence number
sequence = sequence_def.sequence

Returns:

(String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2022.0



533
534

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 533

def sequence_format
end

#sequence_format=(sequence_format) ⇒ `Object`

The #sequence_format= method sets the sequence format of a Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def =
    doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
sequence_def.sequence = "Figure ###"

Parameters:

sequence_format (String)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_SEQUENCE.
(TypeError) —

if sequence_format is not a String or convertable to a String.

Version:

LayOut 2022.0



553
554

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 553

def sequence_format=(sequence_format)
end

#start_index ⇒ `Integer`

The #start_index method returns the start index for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
start_index = sequence_def.start_index

Returns:

(Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, or Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2018



574
575

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 574

def start_index
end

#start_index=(index) ⇒ `Object`

The #start_index= method sets the start index for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, and Layout::AutoTextDefinition::TYPE_SEQUENCE Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
sequence_def.start_index = 10

Parameters:

index (Integer)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER, Layout::AutoTextDefinition::TYPE_PAGE_COUNT, or Layout::AutoTextDefinition::TYPE_SEQUENCE.

Version:

LayOut 2018



595
596

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 595

def start_index=(index)
end

#start_page ⇒ `Layout::Page`

The #start_page method returns the start page for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER and Layout::AutoTextDefinition::TYPE_PAGE_COUNT Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_number_def =
    doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
# Default start page is the first page of the document. However we continue to start at that
# page even if that page is moved.
page = page_number_def.start_page
p page == doc.pages[0]
doc.pages.add('new page')
doc.pages.reorder(doc.pages[0], 1)
p page == doc.pages[1]

Returns:

(Layout::Page)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER or Layout::AutoTextDefinition::TYPE_PAGE_COUNT.

Version:

LayOut 2022.0



621
622

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 621

def start_page
end

#start_page=(page) ⇒ `Object`

The #start_page= method sets the start page for Layout::AutoTextDefinition::TYPE_PAGE_NUMBER and Layout::AutoTextDefinition::TYPE_PAGE_COUNT Layout::AutoTextDefinitions.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page_number_def =
    doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
# Start the PageCount auto-text on the new page
page_number_def.start_page = doc.pages.add('new page')

Parameters:

page (Layout::Page)

Raises:

(ArgumentError) —

if the Layout::AutoTextDefinition‘s type is not Layout::AutoTextDefinition::TYPE_PAGE_NUMBER or Layout::AutoTextDefinition::TYPE_PAGE_COUNT.

Version:

LayOut 2022.0



642
643

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 642

def start_page=(page)
end

#tag ⇒ `String`

The #tag method returns the tag string of the Layout::AutoTextDefinition.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
tag = definitions.first.tag

Returns:

(String)

Version:

LayOut 2018



655
656

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 655

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
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION
Layout::AutoTextDefinition::TYPE_MODEL_SCALE
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME
Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL
Layout::AutoTextDefinition::TYPE_PAGE_COUNT
Layout::AutoTextDefinition::TYPE_SEQUENCE

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
definitions = doc.auto_text_definitions
type = definitions.first.type

Returns:

(Integer)

Version:

LayOut 2018



695
696

# File 'lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb', line 695

def type
end

Class: Layout::AutoTextDefinition

Overview

Examples:

Constant Summary collapse

Instance Method Summary collapse

Instance Method Details

#==(other) ⇒ Boolean

Examples:

#custom_text ⇒ String

Examples:

#custom_text=(custom_text) ⇒ Object

Examples:

#date_format ⇒ String

Examples:

#date_format=(date_format) ⇒ Object

Examples:

#display_file_extension=(display_file_extension) ⇒ Object

Examples:

#display_file_extension? ⇒ Boolean

Examples:

#display_full_path=(display_full_path) ⇒ Object

Examples:

#display_full_path? ⇒ Boolean

Examples:

#end_page ⇒ Layout::Page?

Examples:

#end_page=(page) ⇒ Object

Examples:

#increment ⇒ Integer

Examples:

#increment=(increment) ⇒ Object

Examples:

#mandatory? ⇒ Boolean

Examples:

#name ⇒ String

Examples:

#name=(name) ⇒ Object

Examples:

#number_style ⇒ Integer

Examples:

#number_style=(number_style) ⇒ Object

Examples:

#page_number_style ⇒ Integer

Examples:

#page_number_style=(number_style) ⇒ Object

Examples:

#renumber ⇒ Object

Examples:

#sequence_format ⇒ String

Examples:

#sequence_format=(sequence_format) ⇒ Object

Examples:

#start_index ⇒ Integer

Examples:

#start_index=(index) ⇒ Object

Examples:

#start_page ⇒ Layout::Page

Examples:

#start_page=(page) ⇒ Object

Examples:

#tag ⇒ String

Examples:

#type ⇒ Integer

Examples:

#==(other) ⇒ `Boolean`

#custom_text ⇒ `String`

#custom_text=(custom_text) ⇒ `Object`

#date_format ⇒ `String`

#date_format=(date_format) ⇒ `Object`

#display_file_extension=(display_file_extension) ⇒ `Object`

#display_file_extension? ⇒ `Boolean`

#display_full_path=(display_full_path) ⇒ `Object`

#display_full_path? ⇒ `Boolean`

#end_page ⇒ `Layout::Page`^?

#end_page=(page) ⇒ `Object`

#increment ⇒ `Integer`

#increment=(increment) ⇒ `Object`

#mandatory? ⇒ `Boolean`

#name ⇒ `String`

#name=(name) ⇒ `Object`

#number_style ⇒ `Integer`

#number_style=(number_style) ⇒ `Object`

#page_number_style ⇒ `Integer`

#page_number_style=(number_style) ⇒ `Object`

#renumber ⇒ `Object`

#sequence_format ⇒ `String`

#sequence_format=(sequence_format) ⇒ `Object`

#start_index ⇒ `Integer`

#start_index=(index) ⇒ `Object`

#start_page ⇒ `Layout::Page`

#start_page=(page) ⇒ `Object`

#tag ⇒ `String`

#type ⇒ `Integer`