Files
docx-js/api/classes/xmlcomponent.html
2020-09-05 17:44:49 +00:00

922 lines
39 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>XmlComponent | docx</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.js" 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="../globals.html">Globals</a>
</li>
<li>
<a href="xmlcomponent.html">XmlComponent</a>
</li>
</ul>
<h1>Class XmlComponent</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>
<a href="basexmlcomponent.html" class="tsd-signature-type">BaseXmlComponent</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">XmlComponent</span>
<ul class="tsd-hierarchy">
<li>
<a href="appproperties.html" class="tsd-signature-type">AppProperties</a>
</li>
<li>
<a href="default.html" class="tsd-signature-type">Default</a>
</li>
<li>
<a href="override.html" class="tsd-signature-type">Override</a>
</li>
<li>
<a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a>
</li>
<li>
<a href="bidirectional.html" class="tsd-signature-type">Bidirectional</a>
</li>
<li>
<a href="borderproperty.html" class="tsd-signature-type">BorderProperty</a>
</li>
<li>
<a href="border.html" class="tsd-signature-type">Border</a>
</li>
<li>
<a href="thematicbreak.html" class="tsd-signature-type">ThematicBreak</a>
</li>
<li>
<a href="indent.html" class="tsd-signature-type">Indent</a>
</li>
<li>
<a href="keeplines.html" class="tsd-signature-type">KeepLines</a>
</li>
<li>
<a href="keepnext.html" class="tsd-signature-type">KeepNext</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="style.html" class="tsd-signature-type">Style</a>
</li>
<li>
<a href="footnotereference.html" class="tsd-signature-type">FootnoteReference</a>
</li>
<li>
<a href="fieldinstruction.html" class="tsd-signature-type">FieldInstruction</a>
</li>
<li>
<a href="break.html" class="tsd-signature-type">Break</a>
</li>
<li>
<a href="break.html" class="tsd-signature-type">Break</a>
</li>
<li>
<a href="begin.html" class="tsd-signature-type">Begin</a>
</li>
<li>
<a href="separate.html" class="tsd-signature-type">Separate</a>
</li>
<li>
<a href="end.html" class="tsd-signature-type">End</a>
</li>
<li>
<a href="page.html" class="tsd-signature-type">Page</a>
</li>
<li>
<a href="numberofpages.html" class="tsd-signature-type">NumberOfPages</a>
</li>
<li>
<a href="numberofpagessection.html" class="tsd-signature-type">NumberOfPagesSection</a>
</li>
<li>
<a href="tablegrid.html" class="tsd-signature-type">TableGrid</a>
</li>
<li>
<a href="gridcol.html" class="tsd-signature-type">GridCol</a>
</li>
<li>
<a href="name.html" class="tsd-signature-type">Name</a>
</li>
<li>
<a href="basedon.html" class="tsd-signature-type">BasedOn</a>
</li>
<li>
<a href="next.html" class="tsd-signature-type">Next</a>
</li>
<li>
<a href="link.html" class="tsd-signature-type">Link</a>
</li>
<li>
<a href="uipriority.html" class="tsd-signature-type">UiPriority</a>
</li>
<li>
<a href="unhidewhenused.html" class="tsd-signature-type">UnhideWhenUsed</a>
</li>
<li>
<a href="quickformat.html" class="tsd-signature-type">QuickFormat</a>
</li>
<li>
<a href="tableproperties.html" class="tsd-signature-type">TableProperties</a>
</li>
<li>
<a href="rsid.html" class="tsd-signature-type">RsId</a>
</li>
<li>
<a href="semihidden.html" class="tsd-signature-type">SemiHidden</a>
</li>
<li>
<a href="baseunderline.html" class="tsd-signature-type">BaseUnderline</a>
</li>
<li>
<a href="styles.html" class="tsd-signature-type">Styles</a>
</li>
<li>
<a href="paragraphpropertiesdefaults.html" class="tsd-signature-type">ParagraphPropertiesDefaults</a>
</li>
<li>
<a href="runpropertiesdefaults.html" class="tsd-signature-type">RunPropertiesDefaults</a>
</li>
<li>
<a href="documentdefaults.html" class="tsd-signature-type">DocumentDefaults</a>
</li>
<li>
<a href="tableshading.html" class="tsd-signature-type">TableShading</a>
</li>
<li>
<a href="topcellmargin.html" class="tsd-signature-type">TopCellMargin</a>
</li>
<li>
<a href="bottomcellmargin.html" class="tsd-signature-type">BottomCellMargin</a>
</li>
<li>
<a href="leftcellmargin.html" class="tsd-signature-type">LeftCellMargin</a>
</li>
<li>
<a href="rightcellmargin.html" class="tsd-signature-type">RightCellMargin</a>
</li>
<li>
<a href="tablecellmargin.html" class="tsd-signature-type">TableCellMargin</a>
</li>
<li>
<a href="basetablecellborder.html" class="tsd-signature-type">BaseTableCellBorder</a>
</li>
<li>
<a href="gridspan.html" class="tsd-signature-type">GridSpan</a>
</li>
<li>
<a href="verticalmerge.html" class="tsd-signature-type">VerticalMerge</a>
</li>
<li>
<a href="verticalalign.html" class="tsd-signature-type">VerticalAlign</a>
</li>
<li>
<a href="valign.html" class="tsd-signature-type">VAlign</a>
</li>
<li>
<a href="tdirection.html" class="tsd-signature-type">TDirection</a>
</li>
<li>
<a href="tablecellwidth.html" class="tsd-signature-type">TableCellWidth</a>
</li>
<li>
<a href="tablecell.html" class="tsd-signature-type">TableCell</a>
</li>
<li>
<a href="tableborders.html" class="tsd-signature-type">TableBorders</a>
</li>
<li>
<a href="tableborderselement.html" class="tsd-signature-type">TableBordersElement</a>
</li>
<li>
<a href="basetablecellmargin.html" class="tsd-signature-type">BaseTableCellMargin</a>
</li>
<li>
<a href="tableoverlap.html" class="tsd-signature-type">TableOverlap</a>
</li>
<li>
<a href="tablefloatproperties.html" class="tsd-signature-type">TableFloatProperties</a>
</li>
<li>
<a href="tablelayout.html" class="tsd-signature-type">TableLayout</a>
</li>
<li>
<a href="preferredtablewidth.html" class="tsd-signature-type">PreferredTableWidth</a>
</li>
<li>
<a href="tablerowheight.html" class="tsd-signature-type">TableRowHeight</a>
</li>
<li>
<a href="cantsplit.html" class="tsd-signature-type">CantSplit</a>
</li>
<li>
<a href="tableheader.html" class="tsd-signature-type">TableHeader</a>
</li>
<li>
<a href="tablerow.html" class="tsd-signature-type">TableRow</a>
</li>
<li>
<a href="table.html" class="tsd-signature-type">Table</a>
</li>
<li>
<a href="baseemphasismark.html" class="tsd-signature-type">BaseEmphasisMark</a>
</li>
<li>
<a href="runfonts.html" class="tsd-signature-type">RunFonts</a>
</li>
<li>
<a href="bold.html" class="tsd-signature-type">Bold</a>
</li>
<li>
<a href="boldcomplexscript.html" class="tsd-signature-type">BoldComplexScript</a>
</li>
<li>
<a href="characterspacing.html" class="tsd-signature-type">CharacterSpacing</a>
</li>
<li>
<a href="italics.html" class="tsd-signature-type">Italics</a>
</li>
<li>
<a href="italicscomplexscript.html" class="tsd-signature-type">ItalicsComplexScript</a>
</li>
<li>
<a href="caps.html" class="tsd-signature-type">Caps</a>
</li>
<li>
<a href="color.html" class="tsd-signature-type">Color</a>
</li>
<li>
<a href="doublestrike.html" class="tsd-signature-type">DoubleStrike</a>
</li>
<li>
<a href="emboss.html" class="tsd-signature-type">Emboss</a>
</li>
<li>
<a href="imprint.html" class="tsd-signature-type">Imprint</a>
</li>
<li>
<a href="smallcaps.html" class="tsd-signature-type">SmallCaps</a>
</li>
<li>
<a href="strike.html" class="tsd-signature-type">Strike</a>
</li>
<li>
<a href="size.html" class="tsd-signature-type">Size</a>
</li>
<li>
<a href="sizecomplexscript.html" class="tsd-signature-type">SizeComplexScript</a>
</li>
<li>
<a href="righttoleft.html" class="tsd-signature-type">RightToLeft</a>
</li>
<li>
<a href="highlight.html" class="tsd-signature-type">Highlight</a>
</li>
<li>
<a href="highlightcomplexscript.html" class="tsd-signature-type">HighlightComplexScript</a>
</li>
<li>
<a href="shading.html" class="tsd-signature-type">Shading</a>
</li>
<li>
<a href="shadowcomplexscript.html" class="tsd-signature-type">ShadowComplexScript</a>
</li>
<li>
<a href="text.html" class="tsd-signature-type">Text</a>
</li>
<li>
<a href="run.html" class="tsd-signature-type">Run</a>
</li>
<li>
<a href="symbol.html" class="tsd-signature-type">Symbol</a>
</li>
<li>
<a href="structureddocumenttagcontent.html" class="tsd-signature-type">StructuredDocumentTagContent</a>
</li>
<li>
<a href="alias.html" class="tsd-signature-type">Alias</a>
</li>
<li>
<a href="structureddocumenttagproperties.html" class="tsd-signature-type">StructuredDocumentTagProperties</a>
</li>
<li>
<a href="tableofcontents.html" class="tsd-signature-type">TableOfContents</a>
</li>
<li>
<a href="relationship.html" class="tsd-signature-type">Relationship</a>
</li>
<li>
<a href="relationships.html" class="tsd-signature-type">Relationships</a>
</li>
<li>
<a href="columns.html" class="tsd-signature-type">Columns</a>
</li>
<li>
<a href="documentgrid.html" class="tsd-signature-type">DocumentGrid</a>
</li>
<li>
<a href="footerreference.html" class="tsd-signature-type">FooterReference</a>
</li>
<li>
<a href="headerreference.html" class="tsd-signature-type">HeaderReference</a>
</li>
<li>
<a href="linenumbertype.html" class="tsd-signature-type">LineNumberType</a>
</li>
<li>
<a href="pageborder.html" class="tsd-signature-type">PageBorder</a>
</li>
<li>
<a href="pagemargin.html" class="tsd-signature-type">PageMargin</a>
</li>
<li>
<a href="pagenumbertype.html" class="tsd-signature-type">PageNumberType</a>
</li>
<li>
<a href="pagesize.html" class="tsd-signature-type">PageSize</a>
</li>
<li>
<a href="titlepage.html" class="tsd-signature-type">TitlePage</a>
</li>
<li>
<a href="sectionverticalalign.html" class="tsd-signature-type">SectionVerticalAlign</a>
</li>
<li>
<a href="sectionproperties.html" class="tsd-signature-type">SectionProperties</a>
</li>
<li>
<a href="body.html" class="tsd-signature-type">Body</a>
</li>
<li>
<a href="document.html" class="tsd-signature-type">Document</a>
</li>
<li>
<a href="wrapnone.html" class="tsd-signature-type">WrapNone</a>
</li>
<li>
<a href="wrapsquare.html" class="tsd-signature-type">WrapSquare</a>
</li>
<li>
<a href="wraptight.html" class="tsd-signature-type">WrapTight</a>
</li>
<li>
<a href="wraptopandbottom.html" class="tsd-signature-type">WrapTopAndBottom</a>
</li>
<li>
<a href="simplepos.html" class="tsd-signature-type">SimplePos</a>
</li>
<li>
<a href="align.html" class="tsd-signature-type">Align</a>
</li>
<li>
<a href="positionoffset.html" class="tsd-signature-type">PositionOffset</a>
</li>
<li>
<a href="horizontalposition.html" class="tsd-signature-type">HorizontalPosition</a>
</li>
<li>
<a href="verticalposition.html" class="tsd-signature-type">VerticalPosition</a>
</li>
<li>
<a href="blip.html" class="tsd-signature-type">Blip</a>
</li>
<li>
<a href="sourcerectangle.html" class="tsd-signature-type">SourceRectangle</a>
</li>
<li>
<a href="fillrectangle.html" class="tsd-signature-type">FillRectangle</a>
</li>
<li>
<a href="stretch.html" class="tsd-signature-type">Stretch</a>
</li>
<li>
<a href="blipfill.html" class="tsd-signature-type">BlipFill</a>
</li>
<li>
<a href="piclocks.html" class="tsd-signature-type">PicLocks</a>
</li>
<li>
<a href="childnonvisualproperties.html" class="tsd-signature-type">ChildNonVisualProperties</a>
</li>
<li>
<a href="nonvisualproperties.html" class="tsd-signature-type">NonVisualProperties</a>
</li>
<li>
<a href="nonvisualpicproperties.html" class="tsd-signature-type">NonVisualPicProperties</a>
</li>
<li>
<a href="extents.html" class="tsd-signature-type">Extents</a>
</li>
<li>
<a href="offset.html" class="tsd-signature-type">Offset</a>
</li>
<li>
<a href="form.html" class="tsd-signature-type">Form</a>
</li>
<li>
<a href="adjustmentvalues.html" class="tsd-signature-type">AdjustmentValues</a>
</li>
<li>
<a href="presetgeometry.html" class="tsd-signature-type">PresetGeometry</a>
</li>
<li>
<a href="shapeproperties.html" class="tsd-signature-type">ShapeProperties</a>
</li>
<li>
<a href="pic.html" class="tsd-signature-type">Pic</a>
</li>
<li>
<a href="graphicdata.html" class="tsd-signature-type">GraphicData</a>
</li>
<li>
<a href="graphic.html" class="tsd-signature-type">Graphic</a>
</li>
<li>
<a href="docproperties.html" class="tsd-signature-type">DocProperties</a>
</li>
<li>
<a href="effectextent.html" class="tsd-signature-type">EffectExtent</a>
</li>
<li>
<a href="extent.html" class="tsd-signature-type">Extent</a>
</li>
<li>
<a href="graphicframelocks.html" class="tsd-signature-type">GraphicFrameLocks</a>
</li>
<li>
<a href="graphicframeproperties.html" class="tsd-signature-type">GraphicFrameProperties</a>
</li>
<li>
<a href="anchor.html" class="tsd-signature-type">Anchor</a>
</li>
<li>
<a href="inline.html" class="tsd-signature-type">Inline</a>
</li>
<li>
<a href="drawing.html" class="tsd-signature-type">Drawing</a>
</li>
<li>
<a href="sequentialidentifierinstruction.html" class="tsd-signature-type">SequentialIdentifierInstruction</a>
</li>
<li>
<a href="tab.html" class="tsd-signature-type">Tab</a>
</li>
<li>
<a href="pagebreakbefore.html" class="tsd-signature-type">PageBreakBefore</a>
</li>
<li>
<a href="spacing.html" class="tsd-signature-type">Spacing</a>
</li>
<li>
<a href="contextualspacing.html" class="tsd-signature-type">ContextualSpacing</a>
</li>
<li>
<a href="tabstop.html" class="tsd-signature-type">TabStop</a>
</li>
<li>
<a href="tabstopitem.html" class="tsd-signature-type">TabStopItem</a>
</li>
<li>
<a href="numberproperties.html" class="tsd-signature-type">NumberProperties</a>
</li>
<li>
<a href="indentlevel.html" class="tsd-signature-type">IndentLevel</a>
</li>
<li>
<a href="numberid.html" class="tsd-signature-type">NumberId</a>
</li>
<li>
<a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a>
</li>
<li>
<a href="bookmarkstart.html" class="tsd-signature-type">BookmarkStart</a>
</li>
<li>
<a href="bookmarkend.html" class="tsd-signature-type">BookmarkEnd</a>
</li>
<li>
<a href="outlinelevel.html" class="tsd-signature-type">OutlineLevel</a>
</li>
<li>
<a href="start.html" class="tsd-signature-type">Start</a>
</li>
<li>
<a href="numberformat.html" class="tsd-signature-type">NumberFormat</a>
</li>
<li>
<a href="leveltext.html" class="tsd-signature-type">LevelText</a>
</li>
<li>
<a href="leveljc.html" class="tsd-signature-type">LevelJc</a>
</li>
<li>
<a href="suffix.html" class="tsd-signature-type">Suffix</a>
</li>
<li>
<a href="levelbase.html" class="tsd-signature-type">LevelBase</a>
</li>
<li>
<a href="multileveltype.html" class="tsd-signature-type">MultiLevelType</a>
</li>
<li>
<a href="abstractnumbering.html" class="tsd-signature-type">AbstractNumbering</a>
</li>
<li>
<a href="abstractnumid.html" class="tsd-signature-type">AbstractNumId</a>
</li>
<li>
<a href="concretenumbering.html" class="tsd-signature-type">ConcreteNumbering</a>
</li>
<li>
<a href="leveloverride.html" class="tsd-signature-type">LevelOverride</a>
</li>
<li>
<a href="startoverride.html" class="tsd-signature-type">StartOverride</a>
</li>
<li>
<a href="numbering.html" class="tsd-signature-type">Numbering</a>
</li>
<li>
<a href="title.html" class="tsd-signature-type">Title</a>
</li>
<li>
<a href="subject.html" class="tsd-signature-type">Subject</a>
</li>
<li>
<a href="creator.html" class="tsd-signature-type">Creator</a>
</li>
<li>
<a href="keywords.html" class="tsd-signature-type">Keywords</a>
</li>
<li>
<a href="description.html" class="tsd-signature-type">Description</a>
</li>
<li>
<a href="lastmodifiedby.html" class="tsd-signature-type">LastModifiedBy</a>
</li>
<li>
<a href="revision.html" class="tsd-signature-type">Revision</a>
</li>
<li>
<a href="datecomponent.html" class="tsd-signature-type">DateComponent</a>
</li>
<li>
<a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a>
</li>
<li>
<a href="footnoteref.html" class="tsd-signature-type">FootnoteRef</a>
</li>
<li>
<a href="footnote.html" class="tsd-signature-type">Footnote</a>
</li>
<li>
<a href="continuationseperator.html" class="tsd-signature-type">ContinuationSeperator</a>
</li>
<li>
<a href="seperator.html" class="tsd-signature-type">Seperator</a>
</li>
<li>
<a href="footnotes.html" class="tsd-signature-type">FootNotes</a>
</li>
<li>
<a href="donotexpandshiftreturn.html" class="tsd-signature-type">DoNotExpandShiftReturn</a>
</li>
<li>
<a href="compatibility.html" class="tsd-signature-type">Compatibility</a>
</li>
<li>
<a href="updatefields.html" class="tsd-signature-type">UpdateFields</a>
</li>
<li>
<a href="settings.html" class="tsd-signature-type">Settings</a>
</li>
<li>
<a href="ignoreifemptyxmlcomponent.html" class="tsd-signature-type">IgnoreIfEmptyXmlComponent</a>
</li>
<li>
<a href="importedxmlcomponent.html" class="tsd-signature-type">ImportedXmlComponent</a>
</li>
<li>
<a href="importedrootelementattributes.html" class="tsd-signature-type">ImportedRootElementAttributes</a>
</li>
<li>
<a href="initializablexmlcomponent.html" class="tsd-signature-type">InitializableXmlComponent</a>
</li>
<li>
<a href="alignment.html" class="tsd-signature-type">Alignment</a>
</li>
<li>
<a href="paragraph.html" class="tsd-signature-type">Paragraph</a>
</li>
</ul>
</li>
</ul>
</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 tsd-is-external">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="xmlcomponent.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="xmlcomponent.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="xmlcomponent.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="xmlcomponent.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="xmlcomponent.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Xml<wbr>Component<span class="tsd-signature-symbol">(</span>rootKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d452136/src/file/xml-components/xml-component.ts#L9">src/file/xml-components/xml-component.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rootKey: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="isdeleted" class="tsd-anchor"></a>
<h3>Is<wbr>Deleted</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> IsDeleted<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="apppropertiesattributes.html">AppPropertiesAttributes</a>.<a href="apppropertiesattributes.html#isdeleted">IsDeleted</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d452136/src/file/xml-components/base.ts#L15">src/file/xml-components/base.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addchildelement" class="tsd-anchor"></a>
<h3>add<wbr>Child<wbr>Element</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Child<wbr>Element<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d452136/src/file/xml-components/xml-component.ts#L43">src/file/xml-components/xml-component.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>child: <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="xmlcomponent.html" class="tsd-signature-type">XmlComponent</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d452136/src/file/xml-components/xml-component.ts#L49">src/file/xml-components/xml-component.ts:49</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a name="prepforxml" class="tsd-anchor"></a>
<h3>prep<wbr>For<wbr>Xml</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">prep<wbr>For<wbr>Xml<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">?: </span><a href="file.html" class="tsd-signature-type">File</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="basexmlcomponent.html">BaseXmlComponent</a>.<a href="basexmlcomponent.html#prepforxml">prepForXml</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/d452136/src/file/xml-components/xml-component.ts#L16">src/file/xml-components/xml-component.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <a href="file.html" class="tsd-signature-type">File</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ixmlableobject.html" class="tsd-signature-type">IXmlableObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-is-external">
<a href="xmlcomponent.html" class="tsd-kind-icon">Xml<wbr>Component</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a href="xmlcomponent.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="xmlcomponent.html#isdeleted" class="tsd-kind-icon">Is<wbr>Deleted</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="xmlcomponent.html#addchildelement" class="tsd-kind-icon">add<wbr>Child<wbr>Element</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="xmlcomponent.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a href="xmlcomponent.html#prepforxml" class="tsd-kind-icon">prep<wbr>For<wbr>Xml</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>