smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation to basedOn

Browse Source
This commit is contained in:
Dolan Miu
2023-03-30 19:54:33 +01:00
parent c57aaa856d
commit 44568023cd
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/file/styles/style/style.ts
View File

@ -41,6 +41,13 @@ export interface IStyleAttributes {
export interface IStyleOptions { export interface IStyleOptions {
readonly name?: string; readonly name?: string;
/**
* 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.
* 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 `basedOn` element is ignored.
*
* **WARNING**: You cannot set `basedOn` to be the same as `name`. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.
*/
readonly basedOn?: string; readonly basedOn?: string;
readonly next?: string; readonly next?: string;
readonly link?: string; readonly link?: string;