2021-04-15 11:58:37 +00:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > IFrameOptions | docx< / title >
< meta name = "description" content = "Documentation for docx" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > docx< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > docx< / a >
< / li >
< li >
< a href = "iframeoptions.html" > IFrameOptions< / a >
< / li >
< / ul >
< h1 > Interface IFrameOptions< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > IFrameOptions< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#alignment" class = "tsd-kind-icon" > alignment< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#anchor" class = "tsd-kind-icon" > anchor< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#anchorlock" class = "tsd-kind-icon" > anchor< wbr > Lock< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#dropcap" class = "tsd-kind-icon" > drop< wbr > Cap< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#height" class = "tsd-kind-icon" > height< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#lines" class = "tsd-kind-icon" > lines< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#position" class = "tsd-kind-icon" > position< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#rule" class = "tsd-kind-icon" > rule< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#space" class = "tsd-kind-icon" > space< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#width" class = "tsd-kind-icon" > width< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "iframeoptions.html#wrap" class = "tsd-kind-icon" > wrap< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "alignment" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > alignment< / h3 >
< div class = "tsd-signature tsd-kind-icon" > alignment< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > x< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/horizontalpositionalign.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > HorizontalPositionAlign< / a > < span class = "tsd-signature-symbol" > ; < / span > y< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/verticalpositionalign.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > VerticalPositionAlign< / a > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L46" > src/file/paragraph/frame/frame-properties.ts:46< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > x< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/horizontalpositionalign.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > HorizontalPositionAlign< / a > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > y< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/verticalpositionalign.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > VerticalPositionAlign< / a > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "anchor" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > anchor< / h3 >
< div class = "tsd-signature tsd-kind-icon" > anchor< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > horizontal< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/frameanchortype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FrameAnchorType< / a > < span class = "tsd-signature-symbol" > ; < / span > vertical< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/frameanchortype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FrameAnchorType< / a > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L37" > src/file/paragraph/frame/frame-properties.ts:37< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > horizontal< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/frameanchortype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FrameAnchorType< / a > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > vertical< span class = "tsd-signature-symbol" > : < / span > < a href = "../enums/frameanchortype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FrameAnchorType< / a > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "anchorlock" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > anchor< wbr > Lock< / h3 >
< div class = "tsd-signature tsd-kind-icon" > anchor< wbr > Lock< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L27" > src/file/paragraph/frame/frame-properties.ts:27< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "dropcap" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > drop< wbr > Cap< / h3 >
< div class = "tsd-signature tsd-kind-icon" > drop< wbr > Cap< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/dropcaptype.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DropCapType< / a > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L28" > src/file/paragraph/frame/frame-properties.ts:28< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "height" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > height< / h3 >
< div class = "tsd-signature tsd-kind-icon" > height< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L30" > src/file/paragraph/frame/frame-properties.ts:30< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "lines" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > lines< / h3 >
< div class = "tsd-signature tsd-kind-icon" > lines< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L36" > src/file/paragraph/frame/frame-properties.ts:36< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "position" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > position< / h3 >
< div class = "tsd-signature tsd-kind-icon" > position< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > x< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > y< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L31" > src/file/paragraph/frame/frame-properties.ts:31< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > x< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > y< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "rule" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > rule< / h3 >
< div class = "tsd-signature tsd-kind-icon" > rule< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L45" > src/file/paragraph/frame/frame-properties.ts:45< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "space" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > space< / h3 >
< div class = "tsd-signature tsd-kind-icon" > space< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > horizontal< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > vertical< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L41" > src/file/paragraph/frame/frame-properties.ts:41< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > horizontal< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > vertical< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "width" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > width< / h3 >
< div class = "tsd-signature tsd-kind-icon" > width< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L29" > src/file/paragraph/frame/frame-properties.ts:29< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "wrap" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > wrap< / h3 >
< div class = "tsd-signature tsd-kind-icon" > wrap< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/framewrap.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FrameWrap< / a > < / div >
< aside class = "tsd-sources" >
< ul >
2021-04-26 19:55:21 +00:00
< li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/4d3d971/src/file/paragraph/frame/frame-properties.ts#L35" > src/file/paragraph/frame/frame-properties.ts:35< / a > < / li >
2021-04-15 11:58:37 +00:00
< / ul >
< / aside >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "iframeoptions.html" class = "tsd-kind-icon" > IFrame< wbr > Options< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#alignment" class = "tsd-kind-icon" > alignment< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#anchor" class = "tsd-kind-icon" > anchor< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#anchorlock" class = "tsd-kind-icon" > anchor< wbr > Lock< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#dropcap" class = "tsd-kind-icon" > drop< wbr > Cap< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#height" class = "tsd-kind-icon" > height< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#lines" class = "tsd-kind-icon" > lines< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#position" class = "tsd-kind-icon" > position< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#rule" class = "tsd-kind-icon" > rule< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#space" class = "tsd-kind-icon" > space< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#width" class = "tsd-kind-icon" > width< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "iframeoptions.html#wrap" class = "tsd-kind-icon" > wrap< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
