Documentation

RubyProperties
in package

Ruby properties.

Tags
see
https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.rubyproperties?view=openxml-3.0.1

Table of Contents

Constants

ALIGNMENT_CENTER  = 'center'
ALIGNMENT_DISTRIBUTE_LETTER  = 'distributeLetter'
ALIGNMENT_DISTRIBUTE_SPACE  = 'distributeSpace'
ALIGNMENT_LEFT  = 'left'
ALIGNMENT_RIGHT  = 'right'
ALIGNMENT_RIGHT_VERTICAL  = 'rightVertical'

Properties

$alignment  : string
Ruby alignment (w:rubyAlign).
$baseTextFontSize  : float
Ruby font size for base text (w:hpsBaseText).
$fontFaceSize  : float
Ruby font face size (w:hps).
$fontPointsAboveText  : float
Ruby font points above base text (w:hpsRaise).
$languageId  : string
Ruby type/language id (w:lid).

Methods

__construct()  : mixed
Create a new RubyProperties object.
getAlignment()  : string
Get the ruby alignment.
getFontFaceSize()  : float
Get the ruby font face size.
getFontPointsAboveBaseText()  : float
Get the ruby font points above base text.
getFontSizeForBaseText()  : float
Get the ruby font size for base text.
getLanguageId()  : string
Get the ruby language id.
setAlignment()  : self
Set the Ruby Alignment (center, distributeLetter, distributeSpace, left, right, rightVertical).
setFontFaceSize()  : self
Set the ruby font face size.
setFontPointsAboveBaseText()  : self
Set the ruby font points above base text.
setFontSizeForBaseText()  : self
Set the ruby font size for base text.
setLanguageId()  : self
Set the ruby language id.

Constants

ALIGNMENT_DISTRIBUTE_LETTER

public mixed ALIGNMENT_DISTRIBUTE_LETTER = 'distributeLetter'

ALIGNMENT_DISTRIBUTE_SPACE

public mixed ALIGNMENT_DISTRIBUTE_SPACE = 'distributeSpace'

ALIGNMENT_RIGHT_VERTICAL

public mixed ALIGNMENT_RIGHT_VERTICAL = 'rightVertical'

Properties

$alignment

Ruby alignment (w:rubyAlign).

private string $alignment

$baseTextFontSize

Ruby font size for base text (w:hpsBaseText).

private float $baseTextFontSize

$fontFaceSize

Ruby font face size (w:hps).

private float $fontFaceSize

$fontPointsAboveText

Ruby font points above base text (w:hpsRaise).

private float $fontPointsAboveText

$languageId

Ruby type/language id (w:lid).

private string $languageId

Methods

__construct()

Create a new RubyProperties object.

public __construct() : mixed

getAlignment()

Get the ruby alignment.

public getAlignment() : string
Return values
string

getFontFaceSize()

Get the ruby font face size.

public getFontFaceSize() : float
Return values
float

getFontPointsAboveBaseText()

Get the ruby font points above base text.

public getFontPointsAboveBaseText() : float
Return values
float

getFontSizeForBaseText()

Get the ruby font size for base text.

public getFontSizeForBaseText() : float
Return values
float

getLanguageId()

Get the ruby language id.

public getLanguageId() : string
Return values
string

setAlignment()

Set the Ruby Alignment (center, distributeLetter, distributeSpace, left, right, rightVertical).

public setAlignment(string $alignment) : self
Parameters
$alignment : string
Return values
self

setFontFaceSize()

Set the ruby font face size.

public setFontFaceSize(float $size) : self
Parameters
$size : float
Return values
self

setFontPointsAboveBaseText()

Set the ruby font points above base text.

public setFontPointsAboveBaseText(float $size) : self
Parameters
$size : float
Return values
self

setFontSizeForBaseText()

Set the ruby font size for base text.

public setFontSizeForBaseText(float $size) : self
Parameters
$size : float
Return values
self

setLanguageId()

Set the ruby language id.

public setLanguageId(string $langId) : self
Parameters
$langId : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results