Property | Type | Description | |
---|---|---|---|
ListItemType | ListItemType | ||
ParentContainer | ContainerType |
Property | Type | Description | |
---|---|---|---|
ApplyTextFormattingProperty | void | ||
CreateEdit | System.Xml.Linq.XElement | ||
CreatePicture | |||
GetElementTextLength | int | ||
GetFirstRunEffectedByEdit | |||
GetFirstRunEffectedByEditRecursive | void | ||
GetOrCreate_pPr | System.Xml.Linq.XElement | ||
GetOrCreate_pPr_ind | System.Xml.Linq.XElement | ||
GetOrGenerateRel | string | ||
GetOrGenerateRel | string | ||
GetParagraphNumberProperties | System.Xml.Linq.XElement | ||
InsertHyperlink | |||
Paragraph | System | ||
RebuildDocProperties | void | ||
RemoveHyperlinkRecursive | void | ||
ReplaceAtBookmark_Add | void | ||
SplitEdit | System.Xml.Linq.XElement[] |
Method | Description | |
---|---|---|
Append ( string text ) : |
Append text to this Paragraph.
|
|
AppendBookmark ( String bookmarkName ) : |
||
AppendDocProperty ( |
Append a field of type document property, this field will display the custom property cp, at the end of this paragraph.
|
|
AppendEquation ( String equation ) : |
Add an equation to a document.
|
|
AppendHyperlink ( Novacode.Hyperlink h ) : |
Append a hyperlink to a Paragraph.
|
|
AppendLine ( ) : |
Append a new line to this Paragraph.
|
|
AppendLine ( string text ) : |
Append text on a new line to this Paragraph.
|
|
AppendPageCount ( PageNumberFormat pnf ) : void |
Append a PageCount place holder onto the end of a Paragraph.
|
|
AppendPageNumber ( PageNumberFormat pnf ) : void |
Append a PageNumber place holder onto the end of a Paragraph.
|
|
AppendPicture ( |
Add an image to a document, create a custom view of that image (picture) and then insert it into a Paragraph using append.
|
|
Bold ( ) : |
For use with Append() and AppendLine()
|
|
CapsStyle ( CapsStyle capsStyle ) : |
For use with Append() and AppendLine()
|
|
Color ( Color c ) : |
For use with Append() and AppendLine()
|
|
Culture ( |
For use with Append() and AppendLine()
|
|
CurentCulture ( ) : |
For use with Append() and AppendLine()
|
|
FindAll ( string str ) : List |
Find all instances of a string in this paragraph and return their indexes in a List.
|
|
FindAll ( string str, RegexOptions options ) : List |
Find all instances of a string in this paragraph and return their indexes in a List.
|
|
FindAllByPattern ( string str, RegexOptions options ) : List |
Find all unique instances of the given Regex Pattern
|
|
Font ( |
For use with Append() and AppendLine()
|
|
Font ( string fontName ) : |
For use with Append() and AppendLine()
|
|
FontSize ( double fontSize ) : |
For use with Append() and AppendLine()
|
|
GetBookmarks ( ) : IEnumerable |
||
Hide ( ) : |
For use with Append() and AppendLine()
|
|
Highlight ( Highlight highlight ) : |
For use with Append() and AppendLine()
|
|
InsertAtBookmark ( string toInsert, string bookmarkName ) : void | ||
InsertDocProperty ( |
Insert a field of type document property, this field will display the custom property cp, at the end of this paragraph.
|
|
InsertHorizontalLine ( string lineType = "single", int size = 6, int space = 1, string color = "auto" ) : void | ||
InsertHyperlink ( Novacode.Hyperlink h, int index ) : |
This function inserts a hyperlink into a Paragraph at a specified character index.
|
|
InsertPageBreakAfterSelf ( ) : void |
Insert a page break after a Paragraph.
|
|
InsertPageBreakBeforeSelf ( ) : void |
Insert a page break before a Paragraph.
|
|
InsertPageCount ( PageNumberFormat pnf, int index ) : void |
Insert a PageCount place holder into a Paragraph. This place holder should only be inserted into a Header or Footer Paragraph. Word will not automatically update this field if it is inserted into a document level Paragraph.
|
|
InsertPageNumber ( PageNumberFormat pnf, int index ) : void |
Insert a PageNumber place holder into a Paragraph. This place holder should only be inserted into a Header or Footer Paragraph. Word will not automatically update this field if it is inserted into a document level Paragraph.
|
|
InsertParagraphAfterSelf ( |
Insert a Paragraph after this Paragraph, this Paragraph may have come from the same or another document.
|
|
InsertParagraphAfterSelf ( string text ) : |
Insert a new Paragraph after this Paragraph.
|
|
InsertParagraphAfterSelf ( string text, bool trackChanges ) : |
Insert a new Paragraph after this Paragraph.
|
|
InsertParagraphAfterSelf ( string text, bool trackChanges, |
Insert a new Paragraph after this Paragraph.
|
|
InsertParagraphBeforeSelf ( |
Insert a Paragraph before this Paragraph, this Paragraph may have come from the same or another document.
|
|
InsertParagraphBeforeSelf ( string text ) : |
Insert a new Paragraph before this Paragraph.
|
|
InsertParagraphBeforeSelf ( string text, bool trackChanges ) : |
Insert a new Paragraph before this Paragraph.
|
|
InsertParagraphBeforeSelf ( string text, bool trackChanges, |
Insert a new Paragraph before this Paragraph.
|
|
InsertPicture ( |
Insert a Picture into a Paragraph at the given text index. If not index is provided defaults to 0.
|
|
InsertTableAfterSelf ( |
Insert a new Table after this Paragraph.
|
|
InsertTableAfterSelf ( int rowCount, int columnCount ) : |
Insert a new Table into this document after this Paragraph.
|
|
InsertTableBeforeSelf ( |
Insert a new Table before this Paragraph, this Table can be from this document or another document.
|
|
InsertTableBeforeSelf ( int rowCount, int columnCount ) : |
Insert a new Table into this document before this Paragraph.
|
|
InsertText ( int index, string value, bool trackChanges = false, |
Inserts a specified instance of System.String into a Novacode.DocX.Paragraph at a specified index position.
|
|
InsertText ( string value, bool trackChanges = false, |
Inserts a specified instance of System.String into a Novacode.DocX.Paragraph at a specified index position.
|
|
Italic ( ) : |
For use with Append() and AppendLine()
|
|
KeepLinesTogether ( bool keepTogether = true ) : |
Keep all lines in this paragraph together on a page
|
|
KeepWithNext ( bool keepWithNext = true ) : |
This paragraph will be kept on the same page as the next paragraph
|
|
Kerning ( int kerning ) : |
||
Misc ( Misc misc ) : |
For use with Append() and AppendLine()
|
|
PercentageScale ( int percentageScale ) : |
||
Position ( double position ) : |
||
Remove ( bool trackChanges ) : void |
Remove this Paragraph from the document.
|
|
RemoveHyperlink ( int index ) : void |
Remove the Hyperlink at the provided index. The first hyperlink is at index 0. Using a negative index or an index greater than the index of the last hyperlink will cause an ArgumentOutOfRangeException() to be thrown.
|
|
RemoveText ( int index, bool trackChanges = false ) : void |
Removes characters from a Novacode.DocX.Paragraph.
|
|
RemoveText ( int index, int count, bool trackChanges = false ) : void |
Removes characters from a Novacode.DocX.Paragraph.
|
|
ReplaceAtBookmark ( string toInsert, string bookmarkName ) : void | ||
ReplaceText ( string findPattern, string>.Func |
Find pattern regex must return a group match.
|
|
ReplaceText ( string oldValue, string newValue, bool trackChanges = false, RegexOptions options = RegexOptions.None, |
Replaces all occurrences of a specified System.String in this instance, with another specified System.String.
|
|
Script ( System.Script script ) : |
For use with Append() and AppendLine()
|
|
SetLineSpacing ( LineSpacingType spacingType, float spacingFloat ) : void |
Set the linespacing for this paragraph manually.
|
|
SetLineSpacing ( LineSpacingTypeAuto spacingType ) : void |
Set the linespacing for this paragraph using the Auto value.
|
|
Spacing ( double spacing ) : |
||
SpacingAfter ( double spacingAfter ) : |
||
SpacingBefore ( double spacingBefore ) : |
||
StrikeThrough ( StrikeThrough strikeThrough ) : |
For use with Append() and AppendLine()
|
|
UnderlineColor ( Color underlineColor ) : |
For use with Append() and AppendLine()
|
|
UnderlineStyle ( UnderlineStyle underlineStyle ) : |
For use with Append() and AppendLine()
|
|
ValidateBookmark ( string bookmarkName ) : bool |
Method | Description | |
---|---|---|
ApplyTextFormattingProperty ( System.Xml.Linq.XName textFormatPropName, string value, object content ) : void | ||
CreateEdit ( EditType t, System.DateTime edit_time, object content ) : System.Xml.Linq.XElement |
Creates an Edit either a ins or a del with the specified content and date
|
|
CreatePicture ( |
Insert a Picture at the end of this paragraph. Insert a Picture into this Paragraph at a specified index. Create a new Picture.
|
|
GetElementTextLength ( System.Xml.Linq.XElement run ) : int | ||
GetFirstRunEffectedByEdit ( int index, EditType type = EditType.ins ) : |
||
GetFirstRunEffectedByEditRecursive ( System.Xml.Linq.XElement Xml, int index, int &count, |
||
GetOrCreate_pPr ( ) : System.Xml.Linq.XElement |
If the pPr element doesent exist it is created, either way it is returned by this function.
|
|
GetOrCreate_pPr_ind ( ) : System.Xml.Linq.XElement |
If the ind element doesent exist it is created, either way it is returned by this function.
|
|
GetOrGenerateRel ( Novacode.Hyperlink h ) : string | ||
GetOrGenerateRel ( |
||
GetParagraphNumberProperties ( ) : System.Xml.Linq.XElement | ||
InsertHyperlink ( int index, Novacode.Hyperlink h ) : |
||
Paragraph ( |
||
RebuildDocProperties ( ) : void | ||
RemoveHyperlinkRecursive ( System.Xml.Linq.XElement xml, int index, int &count, bool &found ) : void | ||
ReplaceAtBookmark_Add ( string toInsert, System.Xml.Linq.XElement bookmark ) : void | ||
SplitEdit ( System.Xml.Linq.XElement edit, int index, EditType type ) : System.Xml.Linq.XElement[] |
public Append ( string text ) : |
||
text | string | The text to append. |
return |
public AppendBookmark ( String bookmarkName ) : |
||
bookmarkName | String | |
return |
public AppendDocProperty ( |
||
cp | The custom property to display. | |
trackChanges | bool | |
f | The formatting to use for this text. | |
return |
public AppendEquation ( String equation ) : |
||
equation | String | The Equation to append. |
return |
public AppendHyperlink ( Novacode.Hyperlink h ) : |
||
h | Novacode.Hyperlink | The hyperlink to append. |
return |
public AppendLine ( string text ) : |
||
text | string | The text to append. |
return |
public AppendPageCount ( PageNumberFormat pnf ) : void | ||
pnf | PageNumberFormat | The PageNumberFormat can be normal: (1, 2, ...) or Roman: (I, II, ...) |
return | void |
public AppendPageNumber ( PageNumberFormat pnf ) : void | ||
pnf | PageNumberFormat | The PageNumberFormat can be normal: (1, 2, ...) or Roman: (I, II, ...) |
return | void |
public AppendPicture ( |
||
p | The Picture to append. | |
return |
public CapsStyle ( CapsStyle capsStyle ) : |
||
capsStyle | CapsStyle | The caps style to apply to the last appended text. |
return |
public Color ( Color c ) : |
||
c | Color | A color to use on the appended text. |
return |
public Culture ( |
||
culture | The CultureInfo for text | |
return |
public FindAll ( string str ) : List |
||
str | string | The string to find |
return | List |
public FindAll ( string str, RegexOptions options ) : List |
||
str | string | The string to find |
options | RegexOptions | The options to use when finding a string match. |
return | List |
public FindAllByPattern ( string str, RegexOptions options ) : List |
||
str | string | |
options | RegexOptions | |
return | List |
public Font ( |
||
fontFamily | The font to use for the appended text. | |
return |
public Font ( string fontName ) : |
||
fontName | string | The font to use for the appended text. |
return |
public FontSize ( double fontSize ) : |
||
fontSize | double | The font size to use for the appended text. |
return |
public Highlight ( Highlight highlight ) : |
||
highlight | Highlight | The highlight to apply to the last appended text. |
return |
public InsertAtBookmark ( string toInsert, string bookmarkName ) : void | ||
toInsert | string | |
bookmarkName | string | |
return | void |
public InsertDocProperty ( |
||
cp | The custom property to display. | |
trackChanges | bool | |
f | The formatting to use for this text. | |
return |
public InsertHorizontalLine ( string lineType = "single", int size = 6, int space = 1, string color = "auto" ) : void | ||
lineType | string | |
size | int | |
space | int | |
color | string | |
return | void |
public InsertHyperlink ( Novacode.Hyperlink h, int index ) : |
||
h | Novacode.Hyperlink | The hyperlink to insert. |
index | int | The index to insert at. |
return |
public InsertPageCount ( PageNumberFormat pnf, int index ) : void | ||
pnf | PageNumberFormat | The PageNumberFormat can be normal: (1, 2, ...) or Roman: (I, II, ...) |
index | int | The text index to insert this PageCount place holder at. |
return | void |
public InsertPageNumber ( PageNumberFormat pnf, int index ) : void | ||
pnf | PageNumberFormat | The PageNumberFormat can be normal: (1, 2, ...) or Roman: (I, II, ...) |
index | int | The text index to insert this PageNumber place holder at. |
return | void |
public InsertParagraphAfterSelf ( |
||
p | The Paragraph to insert. | |
return |
public InsertParagraphAfterSelf ( string text ) : |
||
text | string | The initial text for this new Paragraph. |
return |
public InsertParagraphAfterSelf ( string text, bool trackChanges ) : |
||
text | string | The initial text for this new Paragraph. |
trackChanges | bool | Should this insertion be tracked as a change? |
return |
public InsertParagraphAfterSelf ( string text, bool trackChanges, |
||
text | string | The initial text for this new Paragraph. |
trackChanges | bool | Should this insertion be tracked as a change? |
formatting | The formatting to apply to this insertion. | |
return |
public InsertParagraphBeforeSelf ( |
||
p | The Paragraph to insert. | |
return |
public InsertParagraphBeforeSelf ( string text ) : |
||
text | string | The initial text for this new Paragraph. |
return |
public InsertParagraphBeforeSelf ( string text, bool trackChanges ) : |
||
text | string | The initial text for this new Paragraph. |
trackChanges | bool | Should this insertion be tracked as a change? |
return |
public InsertParagraphBeforeSelf ( string text, bool trackChanges, |
||
text | string | The initial text for this new Paragraph. |
trackChanges | bool | Should this insertion be tracked as a change? |
formatting | The formatting to apply to this insertion. | |
return |
public InsertPicture ( |
||
p | The Picture to insert. | |
index | int | The text index to insert at. |
return |
public InsertTableAfterSelf ( |
||
t | The Table t to be inserted. | |
return |
public InsertTableAfterSelf ( int rowCount, int columnCount ) : |
||
rowCount | int | The number of rows this Table should have. |
columnCount | int | The number of columns this Table should have. |
return |
public InsertTableBeforeSelf ( |
||
t | The Table t to be inserted. | |
return |
public InsertTableBeforeSelf ( int rowCount, int columnCount ) : |
||
rowCount | int | The number of rows this Table should have. |
columnCount | int | The number of columns this Table should have. |
return |
public InsertText ( int index, string value, bool trackChanges = false, |
||
index | int | The index position of the insertion. |
value | string | The System.String to insert. |
trackChanges | bool | Flag this insert as a change. |
formatting | The text formatting. | |
return | void |
public InsertText ( string value, bool trackChanges = false, |
||
value | string | The System.String to insert. |
trackChanges | bool | Flag this insert as a change. |
formatting | The text formatting. | |
return | void |
public KeepLinesTogether ( bool keepTogether = true ) : |
||
keepTogether | bool | |
return |
public KeepWithNext ( bool keepWithNext = true ) : |
||
keepWithNext | bool | |
return |
public Misc ( Misc misc ) : |
||
misc | Misc | The miscellaneous property to set. |
return |
public PercentageScale ( int percentageScale ) : |
||
percentageScale | int | |
return |
public Position ( double position ) : |
||
position | double | |
return |
public Remove ( bool trackChanges ) : void | ||
trackChanges | bool | Should this remove be tracked as a change? |
return | void |
public RemoveHyperlink ( int index ) : void | ||
index | int | The index of the hyperlink to be removed. |
return | void |
public RemoveText ( int index, bool trackChanges = false ) : void | ||
index | int | The position to begin deleting characters. |
trackChanges | bool | Track changes |
return | void |
public RemoveText ( int index, int count, bool trackChanges = false ) : void | ||
index | int | The position to begin deleting characters. |
count | int | The number of characters to delete |
trackChanges | bool | Track changes |
return | void |
public ReplaceAtBookmark ( string toInsert, string bookmarkName ) : void | ||
toInsert | string | |
bookmarkName | string | |
return | void |
public ReplaceText ( string findPattern, string>.Func |
||
findPattern | string | Regex pattern that must include one group match. ie (.*) |
regexMatchHandler | string>.Func | A func that accepts the matching find grouping text and returns a replacement value |
trackChanges | bool | |
options | RegexOptions | |
newFormatting | ||
matchFormatting | ||
fo | MatchFormattingOptions | |
return | void |
public ReplaceText ( string oldValue, string newValue, bool trackChanges = false, RegexOptions options = RegexOptions.None, |
||
oldValue | string | A System.String to be replaced. |
newValue | string | A System.String to replace all occurrences of oldValue. |
trackChanges | bool | Track changes |
options | RegexOptions | A bitwise OR combination of RegexOption enumeration options. |
newFormatting | The formatting to apply to the text being inserted. | |
matchFormatting | The formatting that the text must match in order to be replaced. | |
fo | MatchFormattingOptions | How should formatting be matched? |
escapeRegEx | bool | True if the oldValue needs to be escaped, otherwise false. If it represents a valid RegEx pattern this should be false. |
useRegExSubstitutions | bool | True if RegEx-like replace should be performed, i.e. if newValue contains RegEx substitutions. Does not perform named-group substitutions (only numbered groups). |
return | void |
public Script ( System.Script script ) : |
||
script | System.Script | The script style to apply to the last appended text. |
return |
public SetLineSpacing ( LineSpacingType spacingType, float spacingFloat ) : void | ||
spacingType | LineSpacingType | The type of spacing to be set, can be either Before, After or Line (Standard line spacing). |
spacingFloat | float | A float value of the amount of spacing. Equals the value that van be set in Word using the "Line and Paragraph spacing" button. |
return | void |
public SetLineSpacing ( LineSpacingTypeAuto spacingType ) : void | ||
spacingType | LineSpacingTypeAuto | The type of spacing to be set automatically. Using Auto will set both Before and After. None will remove any linespacing. |
return | void |
public Spacing ( double spacing ) : |
||
spacing | double | |
return |
public SpacingAfter ( double spacingAfter ) : |
||
spacingAfter | double | |
return |
public SpacingBefore ( double spacingBefore ) : |
||
spacingBefore | double | |
return |
public StrikeThrough ( StrikeThrough strikeThrough ) : |
||
strikeThrough | StrikeThrough | The strike through style to used on the last appended text. |
return |
public UnderlineColor ( Color underlineColor ) : |
||
underlineColor | Color | The underline color to use, if no underline is set, a single line will be used. |
return |
public UnderlineStyle ( UnderlineStyle underlineStyle ) : |
||
underlineStyle | UnderlineStyle | The underline style to use for the appended text. |
return |
public ValidateBookmark ( string bookmarkName ) : bool | ||
bookmarkName | string | |
return | bool |