2024-10-14 23:42:57 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > ICharacterStyleOptions | docx< / title > < meta name = "description" content = "Documentation for docx" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div > < div class = "field" > < div id = "tsd-toolbar-links" > < / div > < / 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" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" > < li > < a href = "../modules.html" > docx< / a > < / li > < li > < a href = "ICharacterStyleOptions.html" > ICharacterStyleOptions< / a > < / li > < / ul > < h1 > Interface ICharacterStyleOptions< / h1 > < / div > < div class = "tsd-signature" > < span class = "tsd-signature-keyword" > interface < / span > < span class = "tsd-kind-interface" > ICharacterStyleOptions< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#basedOn" > basedOn< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#id" > id< / a > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#link" > link< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#name" > name< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#next" > next< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#quickFormat" > quickFormat< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "ICharacterStyleOptions.html#run" > run< / a > < span class = "tsd-signature-symbol" > ?: < / span > < a href = "IRunStylePropertiesOptions.html" class = "tsd-signature-type tsd-kind-interface" > IRunStylePropertiesOptions< / a > < span class = "tsd-signature-symbol" > ; < / span > < b
2024-10-09 20:29:20 +00:00
< a href = "ICharacterStyleOptions.html#id" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > id< / span > < / a >
< a href = "ICharacterStyleOptions.html#link" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > link?< / span > < / a >
< a href = "ICharacterStyleOptions.html#name" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > name?< / span > < / a >
< a href = "ICharacterStyleOptions.html#next" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > next?< / span > < / a >
< a href = "ICharacterStyleOptions.html#quickFormat" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > quick< wbr / > Format?< / span > < / a >
< a href = "ICharacterStyleOptions.html#run" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > run?< / span > < / a >
< a href = "ICharacterStyleOptions.html#semiHidden" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > semi< wbr / > Hidden?< / span > < / a >
< a href = "ICharacterStyleOptions.html#uiPriority" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > ui< wbr / > Priority?< / span > < / a >
< a href = "ICharacterStyleOptions.html#unhideWhenUsed" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > unhide< wbr / > When< wbr / > Used?< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "basedOn" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > based< wbr / > On< / span > < a href = "#basedOn" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > based< wbr / > On< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Specifies the style upon which the current style is based-that is, the style from which the current style inherits. It is the mechanism for implementing style inheritance.
2023-06-12 19:08:34 +00:00
Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored.
However, if the current style is a numbering style, then the < code > basedOn< / code > element is ignored.< / p >
< p > < strong > WARNING< / strong > : You cannot set < code > basedOn< / code > to be the same as < code > name< / code > . This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.< / p >
2024-10-14 23:42:57 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "IBaseCharacterStyleOptions.html" > IBaseCharacterStyleOptions< / a > .< a href = "IBaseCharacterStyleOptions.html#basedOn" > basedOn< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/32953b3/src/file/styles/style/style.ts#L51" > file/styles/style/style.ts:51< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "id" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > id< / span > < a href = "#id" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > id< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/32953b3/src/file/styles/style/character-style.ts#L10" > file/styles/style/character-style.ts:10< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "link" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > link< / span > < a href = "#link" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > link< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "IBaseCharacterStyleOptions.html" > IBaseCharacterStyleOptions< / a > .< a href = "IBaseCharacterStyleOptions.html#link" > link< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/32953b3/src/file/styles/style/style.ts#L53" > file/styles/style/style.ts:53< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "name" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > name< / span > < a href = "#name" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > name< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "IBaseCharacterStyleOptions.html" > IBaseCharacterStyleOptions< / a > .< a href = "IBaseCharacterStyleOptions.html#name" > name< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/32953b3/src/file/styles/style/style.ts#L43" > file/styles/style/style.ts:43< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "next" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > next< / span > < a href = "#next" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > next< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "IBaseCharacterStyleOptions.html" > IBaseCharacterStyleOptions< / a > .< a href = "IBaseCharacterStyleOptions.html#next" > next< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/32953b3/src/file/styles/style/style.ts#L52" > file/styles/style/style.ts:52< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "quickFormat" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > quick< wbr / >
