# Interface IRunOptions

interface IRunOptions {
allCaps?: boolean;
bold?: boolean;
boldComplexScript?: boolean;
border?: IBorderOptions;
break?: number;
characterSpacing?: number;
children?: readonly (
| string
| FootnoteReferenceRun
| FieldInstruction
| Break
| Begin
| Separate
| End
| NoBreakHyphen
| SoftHyphen
| DayShort
| MonthShort
| YearShort
| DayLong
| MonthLong
| YearLong
| AnnotationReference
| FootnoteReferenceElement
| EndnoteReference
| Separator
| ContinuationSeparator
| PageNumberElement
| CarriageReturn
| Tab
| LastRenderedPageBreak
| PositionalTab)[];
color?: string;
doubleStrike?: boolean;
effect?:
| "none"
| "blinkBackground"
| "lights"
| "antsBlack"
| "antsRed"
| "shimmer"
| "sparkle";
emboss?: boolean;
emphasisMark?: {
type?: "dot";
};
font?: string | IFontAttributesProperties | IFontOptions;
highlight?:
| "none"
| "black"
| "blue"
| "cyan"
| "darkBlue"
| "darkCyan"
| "darkGray"
| "darkGreen"
| "darkMagenta"
| "darkRed"
| "darkYellow"
| "green"
| "lightGray"
| "magenta"
| "red"
| "white"
| "yellow";
highlightComplexScript?: string | boolean;
imprint?: boolean;
italics?: boolean;
italicsComplexScript?: boolean;
kern?:
| number
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`;
language?: ILanguageOptions;
math?: boolean;
noProof?: boolean;
position?:
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`
| `-${number}mm`
| `-${number}cm`
| `-${number}in`
| `-${number}pt`
| `-${number}pc`
| `-${number}pi`;
revision?: IRunPropertiesChangeOptions;
rightToLeft?: boolean;
scale?: number;
shading?: IShadingAttributesProperties;
size?:
| number
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`;
sizeComplexScript?:
| number
| boolean
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`;
smallCaps?: boolean;
snapToGrid?: boolean;
specVanish?: boolean;
strike?: boolean;
style?: string;
subScript?: boolean;
superScript?: boolean;
text?: string;
underline?: {
color?: string;
type?:
| "single"
| "dotDash"
| "dotDotDash"
| "dotted"
| "double"
| "none"
| "thick"
| "wave"
| "words"
| "dottedHeavy"
| "dash"
| "dashedHeavy"
| "dashLong"
| "dashLongHeavy"
| "dashDotHeavy"
| "dashDotDotHeavy"
| "wavyHeavy"
| "wavyDouble";
};
vanish?: boolean;
}

#### Hierarchy (view full)

- IRunPropertiesOptions
  - IRunOptions
    - ISymbolRunOptions

- Defined in file/paragraph/run/run.ts:33

#####
Index

### Properties

allCaps?
bold?
boldComplexScript?
border?
break?
characterSpacing?
children?
color?
doubleStrike?
effect?
emboss?
emphasisMark?
font?
highlight?
highlightComplexScript?
imprint?
italics?
italicsComplexScript?
kern?
language?
math?
noProof?
position?
revision?
rightToLeft?
scale?
shading?
size?
sizeComplexScript?
smallCaps?
snapToGrid?
specVanish?
strike?
style?
subScript?
superScript?
text?
underline?
vanish?

##
Properties

### `Optional` `Readonly` allCaps

allCaps?: boolean

Inherited from IRunPropertiesOptions.allCaps

- Defined in file/paragraph/run/properties.ts:89

### `Optional` `Readonly` bold

bold?: boolean

Inherited from IRunPropertiesOptions.bold

- Defined in file/paragraph/run/properties.ts:70

### `Optional` `Readonly` boldComplexScript

boldComplexScript?: boolean

Inherited from IRunPropertiesOptions.boldComplexScript

- Defined in file/paragraph/run/properties.ts:71

### `Optional` `Readonly` border

border?: IBorderOptions

Inherited from IRunPropertiesOptions.border

- Defined in file/paragraph/run/properties.ts:103

### `Optional` `Readonly` break

break?: number

- Defined in file/paragraph/run/run.ts:97

### `Optional` `Readonly` characterSpacing

characterSpacing?: number

Inherited from IRunPropertiesOptions.characterSpacing

- Defined in file/paragraph/run/properties.ts:97

### `Optional` `Readonly` children

children?: readonly (
| string
| FootnoteReferenceRun
| FieldInstruction
| Break
| Begin
| Separate
| End
| NoBreakHyphen
| SoftHyphen
| DayShort
| MonthShort
| YearShort
| DayLong
| MonthLong
| YearLong
| AnnotationReference
| FootnoteReferenceElement
| EndnoteReference
| Separator
| ContinuationSeparator
| PageNumberElement
| CarriageReturn
| Tab
| LastRenderedPageBreak
| PositionalTab)[]

- Defined in file/paragraph/run/run.ts:69

### `Optional` `Readonly` color

color?: string

Inherited from IRunPropertiesOptions.color

- Defined in file/paragraph/run/properties.ts:82

### `Optional` `Readonly` doubleStrike

doubleStrike?: boolean

Inherited from IRunPropertiesOptions.doubleStrike

- Defined in file/paragraph/run/properties.ts:91

### `Optional` `Readonly` effect

effect?:
| "none"
| "blinkBackground"
| "lights"
| "antsBlack"
| "antsRed"
| "shimmer"
| "sparkle"

Inherited from IRunPropertiesOptions.effect

- Defined in file/paragraph/run/properties.ts:78

### `Optional` `Readonly` emboss

emboss?: boolean

Inherited from IRunPropertiesOptions.emboss

- Defined in file/paragraph/run/properties.ts:99

### `Optional` `Readonly` emphasisMark

emphasisMark?: {
type?: "dot";
}

Inherited from IRunPropertiesOptions.emphasisMark

- Defined in file/paragraph/run/properties.ts:79

### `Optional` `Readonly` font

font?: string | IFontAttributesProperties | IFontOptions

Inherited from IRunPropertiesOptions.font

- Defined in file/paragraph/run/properties.ts:94

### `Optional` `Readonly` highlight

highlight?:
| "none"
| "black"
| "blue"
| "cyan"
| "darkBlue"
| "darkCyan"
| "darkGray"
| "darkGreen"
| "darkMagenta"
| "darkRed"
| "darkYellow"
| "green"
| "lightGray"
| "magenta"
| "red"
| "white"
| "yellow"

Inherited from IRunPropertiesOptions.highlight

- Defined in file/paragraph/run/properties.ts:95

### `Optional` `Readonly` highlightComplexScript

highlightComplexScript?: string | boolean

Inherited from IRunPropertiesOptions.highlightComplexScript

- Defined in file/paragraph/run/properties.ts:96

### `Optional` `Readonly` imprint

imprint?: boolean

Inherited from IRunPropertiesOptions.imprint

- Defined in file/paragraph/run/properties.ts:100

### `Optional` `Readonly` italics

italics?: boolean

Inherited from IRunPropertiesOptions.italics

- Defined in file/paragraph/run/properties.ts:72

### `Optional` `Readonly` italicsComplexScript

italicsComplexScript?: boolean

Inherited from IRunPropertiesOptions.italicsComplexScript

- Defined in file/paragraph/run/properties.ts:73

### `Optional` `Readonly` kern

kern?:
| number
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`

Inherited from IRunPropertiesOptions.kern

- Defined in file/paragraph/run/properties.ts:83

### `Optional` `Readonly` language

language?: ILanguageOptions

Inherited from IRunPropertiesOptions.language

- Defined in file/paragraph/run/properties.ts:102

### `Optional` `Readonly` math

math?: boolean

Inherited from IRunPropertiesOptions.math

- Defined in file/paragraph/run/properties.ts:108

### `Optional` `Readonly` noProof

noProof?: boolean

Inherited from IRunPropertiesOptions.noProof

- Defined in file/paragraph/run/properties.ts:69

### `Optional` `Readonly` position

position?:
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`
| `-${number}mm`
| `-${number}cm`
| `-${number}in`
| `-${number}pt`
| `-${number}pc`
| `-${number}pi`

Inherited from IRunPropertiesOptions.position

- Defined in file/paragraph/run/properties.ts:84

### `Optional` `Readonly` revision

revision?: IRunPropertiesChangeOptions

Inherited from IRunPropertiesOptions.revision

- Defined in file/paragraph/run/properties.ts:101

### `Optional` `Readonly` rightToLeft

rightToLeft?: boolean

Inherited from IRunPropertiesOptions.rightToLeft

- Defined in file/paragraph/run/properties.ts:87

### `Optional` `Readonly` scale

scale?: number

Inherited from IRunPropertiesOptions.scale

- Defined in file/paragraph/run/properties.ts:107

### `Optional` `Readonly` shading

shading?: IShadingAttributesProperties

Inherited from IRunPropertiesOptions.shading

- Defined in file/paragraph/run/properties.ts:98

### `Optional` `Readonly` size

size?:
| number
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`

Inherited from IRunPropertiesOptions.size

- Defined in file/paragraph/run/properties.ts:85

### `Optional` `Readonly` sizeComplexScript

sizeComplexScript?:
| number
| boolean
| `${number}mm`
| `${number}cm`
| `${number}in`
| `${number}pt`
| `${number}pc`
| `${number}pi`

Inherited from IRunPropertiesOptions.sizeComplexScript

- Defined in file/paragraph/run/properties.ts:86

### `Optional` `Readonly` smallCaps

smallCaps?: boolean

Inherited from IRunPropertiesOptions.smallCaps

- Defined in file/paragraph/run/properties.ts:88

### `Optional` `Readonly` snapToGrid

snapToGrid?: boolean

Inherited from IRunPropertiesOptions.snapToGrid

- Defined in file/paragraph/run/properties.ts:104

### `Optional` `Readonly` specVanish

specVanish?: boolean

Inherited from IRunPropertiesOptions.specVanish

- Defined in file/paragraph/run/properties.ts:106

### `Optional` `Readonly` strike

strike?: boolean

Inherited from IRunPropertiesOptions.strike

- Defined in file/paragraph/run/properties.ts:90

### `Optional` `Readonly` style

style?: string

Inherited from IRunPropertiesOptions.style

- Defined in file/paragraph/run/properties.ts:112

### `Optional` `Readonly` subScript

subScript?: boolean

Inherited from IRunPropertiesOptions.subScript

- Defined in file/paragraph/run/properties.ts:92

### `Optional` `Readonly` superScript

superScript?: boolean

Inherited from IRunPropertiesOptions.superScript

- Defined in file/paragraph/run/properties.ts:93

### `Optional` `Readonly` text

text?: string

- Defined in file/paragraph/run/run.ts:98

### `Optional` `Readonly` underline

underline?: {
color?: string;
type?:
| "single"
| "dotDash"
| "dotDotDash"
| "dotted"
| "double"
| "none"
| "thick"
| "wave"
| "words"
| "dottedHeavy"
| "dash"
| "dashedHeavy"
| "dashLong"
| "dashLongHeavy"
| "dashDotHeavy"
| "dashDotDotHeavy"
| "wavyHeavy"
| "wavyDouble";
}

Inherited from IRunPropertiesOptions.underline

- Defined in file/paragraph/run/properties.ts:74

### `Optional` `Readonly` vanish

vanish?: boolean

Inherited from IRunPropertiesOptions.vanish

- Defined in file/paragraph/run/properties.ts:105