2025-04-22 21:18:29 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = "../" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > IPageReferenceOptions | 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 > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => window . app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < a href = "../index.html" class = "title" > docx< / a > < div id = "tsd-toolbar-links" > < / div > < button id = "tsd-search-trigger" class = "tsd-widget" aria-label = "Search" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / button > < dialog id = "tsd-search" aria-label = "Search" > < input role = "combobox" id = "tsd-search-input" aria-controls = "tsd-search-results" aria-autocomplete = "list" aria-expanded = "true" autocapitalize = "off" autocomplete = "off" placeholder = "Search the docs" maxLength = "100" / > < ul role = "listbox" id = "tsd-search-results" > < / ul > < div id = "tsd-search-status" aria-live = "polite" aria-atomic = "true" > < div > Preparing search index...< / div > < / div > < / dialog > < a href = "#" class = "tsd-widget menu" id = "tsd-toolbar-menu-trigger" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" aria-label = "Breadcrumb" > < li > < a href = "" aria-current = "page" > IPageReferenceOptions< / a > < / li > < / ul > < h1 > Type Alias IPageReferenceOptions< / h1 > < / div > < div class = "tsd-signature" > < span class = "tsd-signature-keyword" > type< / span > < span class = "tsd-kind-type-alias" > IPageReferenceOptions< / span > < span class = "tsd-signature-symbol" > =< / span > < span class = "tsd-signature-symbol" > {< / span > < br / > < a class = "tsd-kind-property" href = "#hyperlink" > hyperlink< / a > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "#userelativeposition" > useRelativePosition< / a > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/2b73c243f3f90d37ac3eb1af918d47ddab687322/src/file/paragraph/links/pageref.ts#L8" > file/paragraph/links/pageref.ts:8< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > < h5 class = "tsd-index-heading uppercase" > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "#hyperlink" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > hyperlink?< / span > < / a >
2025-04-16 07:59:44 +00:00
< a href = "#userelativeposition" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > use< wbr / > Relative< wbr / > Position?< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "hyperlink" > < code class = "tsd-tag" > Optional< / code > < code class = "tsd-tag" > Readonly< / code > < span > hyperlink< / span > < a href = "#hyperlink" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > hyperlink< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > \h option - Creates a hyperlink to the bookmarked paragraph.< / p >
2025-04-22 21:18:29 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/2b73c243f3f90d37ac3eb1af918d47ddab687322/src/file/paragraph/links/pageref.ts#L12" > file/paragraph/links/pageref.ts:12< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "userelativeposition" > < code class = "tsd-tag" > Optional< / code > < code class = "tsd-tag" > Readonly< / code > < span > use< wbr / > Relative< wbr / > Position< / span > < a href = "#userelativeposition" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > useRelativePosition< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > \p option - Causes the field to display its position relative to the source
2024-10-14 23:43:47 +00:00
bookmark. If the PAGEREF field is on the same page as the
bookmark, it omits " on page #" and returns " above" or " below"
only. If the PAGEREF field is not on the same page as the
bookmark, the string " on page #" is used.< / p >
2025-04-22 21:18:29 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/dolanmiu/docx/blob/2b73c243f3f90d37ac3eb1af918d47ddab687322/src/file/paragraph/links/pageref.ts#L20" > file/paragraph/links/pageref.ts:20< / a > < / li > < / ul > < / aside > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h3 > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-external" name = "external" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > External< / span > < / label > < / li > < / ul > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h3 > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#hyperlink" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > hyperlink< / span > < / a > < a href = "#userelativeposition" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > use< wbr / > Relative< wbr / > Position< / span > < / a > < / div > < / details > < / div > < / details > < / div > < div class = "site-menu" > < nav class = "tsd-navigation" > < a href = "../modules.html" > docx< / a > < ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" > < li > Loading...< / li > < / ul > < / nav > < / div > < / div > < / div > < footer > < p class = "tsd-generator" > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p > < / footer > < div class = "overlay" > < / div > < / body > < / html >
