.. highlightlang:: us

.. index:: TBGetProps

.. _tbgetprops:

TBGetProps
============

.. us.tag  TBGetProps ENGLISH TB_Get New5800

:ref:`TBGetProps` gets the font properties.

.. function::  o = TBGetProps(hTB)

.. us.return

**Return Value**

*o*

**text-box**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - text-box
     - 
   * - name
     - string
     -        
     -  Object name
   * - @atts_xy_width_height
     - 
     - 
     - 
   * - @atts_pen
     - 
     - 
     - 
   * - flags
     - @flags
     - 
     - 
   * - @atts_misc
     - 
     - 
     - 
   * - @atts_background
     - 
     - 
     - 
   * - halign
     - @halign 
     - center 
     - Horizontal alignment: left, center (default), right
   * - valign
     - @valign
     - middle
     - Top:8 middle:16 bottom:32
   * - angle
     - double  
     - 0
     - 
   * - edge-dist
     - double  
     - 0
     - 
   * - auto-size
     - double  
     - 0
     - 
   * - word-wrap
     - bool
     - 0
     - 
   * - clip-text
     - bool
     - 0
     - 
   * - text
     - string
     - 
     - 
   * - %font
     - %font
     - 
     - 

**atts_xy_width_height**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * -  x               
     - double
     - 1.0
     -  x position in cm or diagram coordinates
   * -  y               
     - double
     - -1.0
     -  
   * -  width           
     - double
     - 1.0
     -  
   * -  height          
     - double
     - 1.0
     - 

**atts_pen**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - stroke-type
     - int
     - 0
     - 
   * - stroke-width
     - int
     - 1
     - 
   * - stroke-color
     - @color
     - black
     - 

**atts_misc**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - shadow
     - bool
     - 0
     - 
   * - shadow-width
     - double
     - 20
     - 
   * - round-rect
     - bool
     - 0
     - 
   * - radius
     - double
     - 0.3
     - 
   * - show-edge
     - bool
     - 0
     - 

**atts_background**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - bkmode
     - @bkmode
     - transparent
     -  opaque:0  transparent:1
   * - gradient
     - bool
     - 0
     - 
   * - gradient-colors
     - @color
     - white grey
     - 
   * - fill-color
     - @color
     - black
     - 

**font**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - font
     - 
   * - face-name
     - string
     - Arial
     - 
   * - size
     - int
     - 9
     - 
   * - weight
     - int
     - 400
     - 
   * - italic
     - bool
     - 0
     - 
   * - underline
     - bool
     - 0
     - 
   * - strike-out
     - bool
     - 0
     - 
   * - color
     - @color
     - black
     - 
   * - pitch-and-family
     - int
     - 34
     - 

.. us.params

**Parameters**

.. uparam:: hTB

   Identifies the text-box.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2016.0
     - New.

.. seealso::
   :ref:`overview-text-objects`,
   :ref:`TBCreate`,
   :ref:`TBSetProps`,
   :ref:`ObjSetProps`

:sub:`id-846829`