pycatia.drafting_interfaces.drawing_text_properties

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.drawing_text_properties.DrawingTextProperties(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

DrawingTextProperties

Represents the properties of a drawing text in a drawing view.

This interface is obtained from CATIADrawingText or CATIADrawingWelding

interface. Update method must be called after text properties modification to

refresh the visualization.

activate_frame(i_type: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ActivateFrame(CatTextFrameType iType)

Activates the text frame of the drawing text.

Parameters:

iType

The text frame type

Example:

This example add a rectangle frame to MyText drawing

text.

CatTextFrameType itype = catRectangle

MyText.ActivateFrame itype

Example:

This example remove the frame to MyText drawing text.

CatTextFrameType itype = catNone

MyText.ActivateFrame itype

Parameters:

i_type (int) – enum cat_text_frame_type

Return type:

None

property anchor_point: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property AnchorPoint() As CatTextAnchorPosition

Returns or sets the anchor point of the drawing text.

Example:

This example sets the AnchorPoint of the MyText drawing text to the

right

MyText.AnchorPoint = catRight

Returns:

enum cat_text_anchor_position

Return type:

int

property blanking: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Blanking() As CatBlankingMode

Returns or sets the blanking mode of the drawing text.

Example:

This example sets the blanking mode type of MyText drawing text to

active on geom

MyText.Blanking = catBlankingOnGeom

Returns:

enum cat_blanking_mode

Return type:

int

property bold: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Bold() As long

Returns or sets the drawing text font bold property.

True if the drawing text is bold formatted.

Example:

This example get the parameter bold on MyText drawing

text.

oVal = MyText.Bold

Return type:

int

property color: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Color() As long

Returns or sets the color of the drawing text.

Example:

This example sets the Color type of the MyText drawing text to

red

redCol =-16776961 ‘Encoded RGBA color within long integer (R=255 G=0

B=0 A=255)

MyText.Color = redCol

Return type:

int

property font_name: str

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FontName() As CATBSTR

Returns or sets the font name of the drawing text.

Example:

This example sets the MyText drawing text font as Courrier 10

BT.

MyText.SetFontName(“Courrier 10 BT”)

Return type:

str

property font_size: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FontSize() As double

Returns or sets the font size of the drawing text.

Example:

This example sets the MyText drawing text font size to

3.5.

iFontSize = 3.5

MyText.SetFontSize 0, 0, iFontSize

Return type:

float

property frame_type: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FrameType() As CatTextFrameType

Returns or sets the frame type of the drawing text.

Example:

This example sets the frame type of the MyText drawing text to an

ellipse

MyText.FrameType = catEllipse

Returns:

enum cat_text_frame_type

Return type:

int

property italic: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Italic() As long

Returns or sets the drawing text font italic property.

True if the drawing text is formatted as italic.

Example:

This example set the parameter Italic on MyText drawing

text.

MyText.Italic = 1

Return type:

int

property justification: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Justification() As CatJustification

Returns or sets the drawing text font justification

property.

True if the drawing text font is justified.

Example:

This example sets the Justification type of the MyText drawing text to

the right

MyText.Justification = catRight

Returns:

enum cat_justification

Return type:

int

property kerning: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Kerning() As long

Font kerning property.

True if the drawing text font is formatted as kerning

Example:

This example set the parameter kerning on MyText drawing

text.

MyText.Kerning = 1

Return type:

int

property mirror: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Mirror() As CatTextFlipMode

Returns or sets the mirroring of the drawing text.

Example:

This example sets the Mirror type of the MyText drawing text to no

flip

MyText.Mirror = catTextNoFlip

Returns:

enum cat_text_flip_mode

Return type:

int

property overline: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Overline() As long

Returns or sets the drawing text font overline property.

True if the drawing text is overlined.

Example:

This example get the parameter Overline on MyText drawing

text.

oval = MyText.Overline()

Return type:

int

property strike_thru: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property StrikeThru() As long

Returns or sets the drawing text font strikethrough

property.

True if the drawing text font is striked through.

Example:

This example set the parameter StrikeThru on MyText drawing

text.

MyText.StrikeThru = 1

Return type:

int

property subscript: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Subscript() As long

Returns or sets the drawing text font subscript property.

True if the drawing text font is formatted as subscript.

Example:

This example set the parameter Subscript on MyText drawing

text.

MyText.Subscript = 1

Return type:

int

property superscript: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Superscript() As long

Returns or sets the drawing text font superscript

property.

True if the drawing text font is formatted as superscript.

Example:

This example set the parameter Superscript on MyText drawing

text.

MyText.Superscript = 1

Return type:

int

property underline: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Underline() As long

Returns or sets the drawing text font underline property.

True if the drawing text is underlined.

Example:

This example get the parameter bold on MyText drawing

text.

oval = MyText.Underline

Return type:

int

update() → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Update()

Update the properties of the drawing text.

Example:

This example update the properties to MyText drawing text.

MyText.Update

Copyright © 1999-2011, Dassault Systèmes. All rights

reserved.

Return type:

None