24143 lines
989 KiB
XML
24143 lines
989 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Spire.Doc</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="M:Spire.License.LicenseProvider.UnbindDevelopmentOrTestingLicenses(System.Type,System.String@)">
|
|
<summary>
|
|
Unbinds development or testing licenses of the specified type.
|
|
The approach to lifting development or testing licenses does not allow frequent invocation by the same machine code,
|
|
mandating a two-hour wait period before it can be invoked again.
|
|
</summary>
|
|
<param name="type">The type of the license to unbind.</param>
|
|
<param name="errorMsg">The error message in case of failure.</param>
|
|
<returns>True if at least one development or test license was unbound, otherwise false.</returns>
|
|
</member>
|
|
<member name="T:Spire.License.Blacklist">
|
|
<summary>
|
|
Authorization Blacklist
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.License.Blacklist.BlacklistData">
|
|
<summary>
|
|
The serial number or the MD5 code of the key that is entered into the authorization blacklist.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the DocAI class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.UploadFile(System.String,System.IO.Stream)">
|
|
<summary>
|
|
Uploads a file to the AI service.
|
|
</summary>
|
|
<param name="fileName">The name of the file to be uploaded.</param>
|
|
<param name="stream">The stream containing the file data.</param>
|
|
<returns>The result contains the file path on ai server as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.UploadDocument(Spire.Doc.Document)">
|
|
<summary>
|
|
Uploads document to the AI service.
|
|
</summary>
|
|
<param name="document">document.</param>
|
|
<returns>The result contains the file path on ai server as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ResetChatHistory(System.String)">
|
|
<summary>
|
|
Resets the chat history in the AI service.
|
|
</summary>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ResetUserHistory">
|
|
<summary>
|
|
Resets the user's all chat history in the AI service.
|
|
</summary>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentMerge(Spire.Doc.Document,System.Collections.Generic.List{Spire.Doc.Document})">
|
|
<summary>
|
|
Merges the data from multiple documents into a destination document using AI.
|
|
</summary>
|
|
<param name="descDocument">The destination document where the merged data will be placed.</param>
|
|
<param name="srcDocuments">The list of source documents containing the data to be merged.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Ask(System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using AI.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
<returns>A task that represents the asynchronous operation. The task result contains the generated answer as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Search(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using AI.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="language">language of answer.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
<returns>result contains the generated answer as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ImageGenerate(System.String)">
|
|
<summary>
|
|
Generate images from text using AI.
|
|
</summary>
|
|
<param name="description">text description about image.</param>
|
|
<returns>the stream of the Image.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ImageGenerate(System.String,Spire.Doc.AI.ImageGenarationModel,Spire.Doc.AI.ImageGenarationSize)">
|
|
<summary>
|
|
Generate images from text using AI.
|
|
</summary>
|
|
<param name="description">text description about image.</param>
|
|
<param name="model">Image Models for generation.</param>
|
|
<param name="size">Image Size for generation.</param>
|
|
<returns>the stream of the Image.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentSearch(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using the AI service with the specified question, for a file based on server-side path.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="file_server_path">The file server path.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentSearch(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Performs a question-searching task using the AI service with the specified question.
|
|
</summary>
|
|
<param name="question">The question to be searched.</param>
|
|
<param name="file_server_path">QA for a file based on server-side path.</param>
|
|
<param name="options">extra options.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
<returns>result contains the generated answer as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Translate(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Translates the text within the specified document.
|
|
</summary>
|
|
<param name="document">The document representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Translate(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Translates the text within the specified paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Translate(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Translates the text within the text range.
|
|
</summary>
|
|
<param name="textRange">The text range representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWriting(Spire.Doc.Document,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the document, continue the writing of the article.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWriting(Spire.Doc.Documents.Paragraph,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the paragraph, continue the writing of the article.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWriting(Spire.Doc.Fields.TextRange,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the text range, continue the writing of the article.
|
|
</summary>
|
|
<param name="textRange">The text range.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerate(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Generate an abstract within the document.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerate(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Generate an abstract within the paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerate(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Generate an abstract within the text range.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerate(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Generate an summary within the document.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerate(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Generate an summary within the paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerate(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Generate an summary within the text range.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheck(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Check the spelling of the document.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheck(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Check the spelling of the paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheck(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Check the spelling of the document.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Polish(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Polish the document.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Polish(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Polish the text of paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.Polish(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Polish the text of textrange.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentGenerate(Spire.Doc.Document,System.String,System.Int32,System.String,System.String[])">
|
|
<summary>
|
|
Based on the topic to create a document.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<param name="topic">The topic of the document.</param>
|
|
<param name="wordsCount">The minium word count of the document.</param>
|
|
<param name="language">The target language for AI write in.</param>
|
|
<param name="formatRequirements">The formats requirement of the document.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognition(Spire.Doc.Document,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the document.
|
|
</summary>
|
|
<param name="document">The document representing the source data.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognition(Spire.Doc.Documents.Paragraph,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph representing the source data.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognition(Spire.Doc.Fields.TextRange,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the text range.
|
|
</summary>
|
|
<param name="textRange">The text range representing the source data.</param>
|
|
<returns>A sync task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.UploadFileAsync(System.String,System.IO.Stream)">
|
|
<summary>
|
|
Uploads a file to the AI service.
|
|
</summary>
|
|
<param name="fileName">The name of the file to be uploaded.</param>
|
|
<param name="stream">The stream containing the file data.</param>
|
|
<returns>A task that represents the asynchronous operation. The task result contains the file path on ai server as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.UploadDocumentAsync(Spire.Doc.Document)">
|
|
<summary>
|
|
Uploads document to the AI service.
|
|
</summary>
|
|
<param name="document">document.</param>
|
|
<returns>A async task that represents the asynchronous operation. The task result contains the file path on ai server as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ResetChatHistoryAsync(System.String)">
|
|
<summary>
|
|
Resets the chat history in the AI service.
|
|
</summary>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ResetUserHistoryAsync">
|
|
<summary>
|
|
Resets the user's all chat history in the AI service.
|
|
</summary>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentMergeAsync(Spire.Doc.Document,System.Collections.Generic.List{Spire.Doc.Document})">
|
|
<summary>
|
|
Merges the data from multiple documents into a destination document using AI.
|
|
</summary>
|
|
<param name="descDocument">The destination document where the merged data will be placed.</param>
|
|
<param name="srcDocument">The list of source documents containing the data to be merged.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AskAsync(System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using AI.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
<returns>A task that represents the asynchronous operation. The task result contains the generated answer as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentSearchAsync(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using the AI service with the specified question, for a file based on server-side path.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="file_server_path">The file server path.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentSearchAsync(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
|
|
<summary>
|
|
Performs a question-answering task using the AI service with the specified question, for a file based on server-side path.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="file_server_path">The file server path.</param>
|
|
<param name="options">extra options.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SearchAsync(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Performs a question-searching task using AI.
|
|
</summary>
|
|
<param name="question">The question to be answered.</param>
|
|
<param name="language">language of answer.</param>
|
|
<param name="enableHistory">Flag indicating whether to enable chat history.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ImageGenerateAsync(System.String)">
|
|
<summary>
|
|
Generate images from text using AI.
|
|
</summary>
|
|
<param name="description">text description about image.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ImageGenerateAsync(System.String,Spire.Doc.AI.ImageGenarationModel,Spire.Doc.AI.ImageGenarationSize)">
|
|
<summary>
|
|
Generate images from text using AI.
|
|
</summary>
|
|
<param name="description">text description about image.</param>
|
|
<param name="model">Image Models for generation.</param>
|
|
<param name="size">Image Size for generation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.TranslateAsync(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Translates the text within the specified document using AI.
|
|
</summary>
|
|
<param name="document">The document representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.TranslateAsync(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Translates the text within the specified paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.TranslateAsync(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Translates the text within the text range using AI.
|
|
</summary>
|
|
<param name="textRange">The text range representing the source data.</param>
|
|
<param name="language">The target language for translation.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWritingAsync(Spire.Doc.Document,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the document, continue the writing of the article.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWritingAsync(Spire.Doc.Documents.Paragraph,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the paragraph, continue the writing of the article.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.ContinueWritingAsync(Spire.Doc.Fields.TextRange,System.String,System.String,System.String)">
|
|
<summary>
|
|
According to the text range, continue the writing of the article.
|
|
</summary>
|
|
<param name="textRange">The text range.</param>
|
|
<param name="topic">The topic of the article.</param>
|
|
<param name="language">The default language of the article.</param>
|
|
<param name="extraInfo">The extraInfo.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerateAsync(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Generate an abstract within the document using AI.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerateAsync(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Generate an abstract within the paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.AbstractGenerateAsync(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Generate an abstract within the text range using AI.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerateAsync(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Generate an summary within the document using AI.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerateAsync(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Generate an summary within the paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SummaryGenerateAsync(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Generate an summary within the text range using AI.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheckAsync(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Check the spelling of the document using AI.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheckAsync(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Check the spelling of the paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.SpellCheckAsync(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Check the spelling of the document using AI.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.PolishAsync(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Polish the document using AI.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.PolishAsync(Spire.Doc.Documents.Paragraph,System.String)">
|
|
<summary>
|
|
Polish the text of specific paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.PolishAsync(Spire.Doc.Fields.TextRange,System.String)">
|
|
<summary>
|
|
Polish the text of specific range using AI.
|
|
</summary>
|
|
<param name="textRange">The text range to add the content written by AI.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.DocumentGenerateAsync(Spire.Doc.Document,System.String,System.Int32,System.String,System.String[])">
|
|
<summary>
|
|
Based on the topic to create a document using AI.
|
|
</summary>
|
|
<param name="document">The document to add the content written by AI.</param>
|
|
<param name="topic">The topic of the document.</param>
|
|
<param name="wordsCount">The minim word count of the document.</param>
|
|
<param name="language">The target language for AI write in.</param>
|
|
<param name="format">The format requirement of the document.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognitionAsync(Spire.Doc.Document,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the document using AI.
|
|
</summary>
|
|
<param name="document">The document representing the source data.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognitionAsync(Spire.Doc.Documents.Paragraph,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the paragraph using AI.
|
|
</summary>
|
|
<param name="paragraph">The paragraph representing the source data.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.DocAI.EntityRecognitionAsync(Spire.Doc.Fields.TextRange,System.String,System.String[])">
|
|
<summary>
|
|
Recognize the entities within the text range using AI.
|
|
</summary>
|
|
<param name="textRange">The text range representing the source data.</param>
|
|
<returns>An async task that returns a string indicating whether the processing was successful or not.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.AIApi.DownloadFile(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Download file
|
|
</summary>
|
|
<exception cref="T:Spire.Doc.AI.Client.ApiException">Thrown when fails to make API call</exception>
|
|
<param name="path">File path e.g. '/folder/file.ext'</param>
|
|
<returns>System.IO.Stream</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.AIApi.DownloadFileWithHttpInfo(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Download file
|
|
</summary>
|
|
<exception cref="T:Spire.Doc.AI.Client.ApiException">Thrown when fails to make API call</exception>
|
|
<param name="path">File path e.g. '/folder/file.ext'</param>
|
|
<returns>ApiResponse of System.IO.Stream</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.AIApi.DownloadFileAsync(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Download file
|
|
</summary>
|
|
<exception cref="T:Spire.Doc.AI.Client.ApiException">Thrown when fails to make API call</exception>
|
|
<param name="path">File path e.g. '/folder/file.ext'</param>
|
|
<returns>System.IO.Stream</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.AI.AIApi.DownloadFileAsyncWithHttpInfo(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Download file
|
|
</summary>
|
|
<exception cref="T:Spire.Doc.AI.Client.ApiException">Thrown when fails to make API call</exception>
|
|
<param name="path">File path e.g. '/folder/file.ext'</param>
|
|
<returns>ApiResponse of System.IO.Stream</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.AI.SpireAI.Credits">
|
|
<summary>
|
|
Gets Remaining Credits.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.AI.SpireAI.NumberCost">
|
|
<summary>
|
|
Gets the cost for the last call.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.AI.ImageGenarationModel">
|
|
<summary>
|
|
Supported Image Models for generation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AI.ImageGenarationModel.STABLE_DIFFUSION_512_V2_1">
|
|
<summary>
|
|
stable diffusion
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AI.ImageGenarationModel.STABLE_DIFFUSION_XL_1024_V1_0">
|
|
<summary>
|
|
stable diffusion XL
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.AI.ImageGenarationSize">
|
|
<summary>
|
|
Supported Image Size for generation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AI.ImageGenarationSize.I512x512">
|
|
<summary>
|
|
512*512
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AI.ImageGenarationSize.I1024x1024">
|
|
<summary>
|
|
1024*1024
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CompoundFile.BuiltInProperty">
|
|
<summary>
|
|
Property IDs for the SummaryInformation Property Set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Title">
|
|
<summary>
|
|
Title document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Subject">
|
|
<summary>
|
|
Subject document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Author">
|
|
<summary>
|
|
Author document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Keywords">
|
|
<summary>
|
|
Keywords document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Comments">
|
|
<summary>
|
|
Comments document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Template">
|
|
<summary>
|
|
Template document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LastAuthor">
|
|
<summary>
|
|
LastAuthor document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.RevisionNumber">
|
|
<summary>
|
|
Revnumber document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.EditTime">
|
|
<summary>
|
|
EditTime document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LastPrinted">
|
|
<summary>
|
|
LastPrinted document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.CreationDate">
|
|
<summary>
|
|
CreationDate document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LastSaveDate">
|
|
<summary>
|
|
LastSaveDate document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.PageCount">
|
|
<summary>
|
|
PageCount document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.WordCount">
|
|
<summary>
|
|
WordCount document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.CharCount">
|
|
<summary>
|
|
CharCount document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Thumbnail">
|
|
<summary>
|
|
Thumbnail document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ApplicationName">
|
|
<summary>
|
|
ApplicationName document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Security">
|
|
<summary>
|
|
Ssecurity document property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Category">
|
|
<summary>
|
|
Category Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.PresentationTarget">
|
|
<summary>
|
|
Target format for presentation (35mm, printer, video, and so on) id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ByteCount">
|
|
<summary>
|
|
ByteCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LineCount">
|
|
<summary>
|
|
LineCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ParagraphCount">
|
|
<summary>
|
|
ParCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.SlideCount">
|
|
<summary>
|
|
SlideCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.NoteCount">
|
|
<summary>
|
|
NoteCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.HiddenCount">
|
|
<summary>
|
|
HiddenCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.MultimediaClipCount">
|
|
<summary>
|
|
MmclipCount Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ScaleCrop">
|
|
<summary>
|
|
ScaleCrop property Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.HeadingPair">
|
|
<summary>
|
|
HeadingPair Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.DocParts">
|
|
<summary>
|
|
DocParts Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Manager">
|
|
<summary>
|
|
Manager Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Company">
|
|
<summary>
|
|
Company Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LinksDirty">
|
|
<summary>
|
|
LinksDirty Id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.CharactersWithSpaces">
|
|
<summary>
|
|
MUST be a VT_I4 TypedPropertyValue ([MS-OLEPS] section 2.15) property. The integer value of the
|
|
property specifies an Eschertimate of the number of characters in the document including whitespace.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ShareDoc">
|
|
<summary>
|
|
MUST be a VT_BOOL TypedPropertyValue ([MS-OLEPS] section 2.15) property.
|
|
The property value MUST be FALSE (0x00000000).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.LinkBase">
|
|
<summary>
|
|
MUST NOT be written (to built-in properties). The base URL property is persisted to the User Defined Property
|
|
Set with the _PID_LINKBASE property name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Hyperlinks">
|
|
<summary>
|
|
MUST NOT be written (to built-in properties). The hyperlinks property is persisted to the User Defined Property
|
|
Set with the _PID_HLINKS property name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.HyperlinksChanged">
|
|
<summary>
|
|
MUST be a VT_BOOL TypedPropertyValue ([MS-OLEPS] section 2.15) property. The property value
|
|
specifies TRUE (any value other than 0x00000000) if the _PID_HLINKS property in the User
|
|
Defined Property Set has changed outside of the application, which would require hyperlink
|
|
fix up on document load.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Version">
|
|
<summary>
|
|
Version of the application that created the document.
|
|
|
|
MUST be a VT_I4 TypedPropertyValue ([MS-OLEPS] section 2.15) property. The unsigned integer
|
|
value of the property specifies the version of the application that wrote the property set storage.
|
|
The two high order bytes specify an unsigned integer specifying the major version number.
|
|
The two low order bytes specify an unsigned integer specifying the minor version number.
|
|
The value MUST have the major version number set to a nonzero value, and the minor version
|
|
number SHOULD always be 0x0000. The minor version number MAY be set to the minor version
|
|
number of the application that wrote the property set storage.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ExcelDigitalSignature">
|
|
<summary>
|
|
Represents a digital signature in an Excel document, used to verify the integrity and authenticity of the file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ContentType">
|
|
<summary>
|
|
MUST be a VtString property. VtString.stringValue specifies the content type of the file.
|
|
MAY be absent.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.ContentStatus">
|
|
<summary>
|
|
MUST be a VtString property. VtString.stringValue specifies the document status. MAY be absent.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.Language">
|
|
<summary>
|
|
MUST be a VtString property. SHOULD be absent.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.BuiltInProperty.DocVersion">
|
|
<summary>
|
|
MUST be a VtString property. SHOULD be absent.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CompoundFile.PropertyType">
|
|
<summary>
|
|
Enumeration with all supported property types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Bool">
|
|
<summary>
|
|
Indicates a Boolean value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Int">
|
|
<summary>
|
|
Indicates an integer value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Int32">
|
|
<summary>
|
|
Indicates an 4-bytes signed integer value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Int16">
|
|
<summary>
|
|
Indicates a wide string terminated by a null.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.UInt32">
|
|
<summary>
|
|
Indicates a 4-bytes unsigned interger value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.String">
|
|
<summary>
|
|
Indicates a wide string terminated by a null.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.AsciiString">
|
|
<summary>
|
|
Indicates a FILETIME value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.DateTime">
|
|
<summary>
|
|
Indicates a FILETIME value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Blob">
|
|
<summary>
|
|
Indicates length prefixed bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Vector">
|
|
<summary>
|
|
Indicates a simple, counted array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Object">
|
|
<summary>
|
|
Indicates an object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Double">
|
|
<summary>
|
|
Indicates a double value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Empty">
|
|
<summary>
|
|
Indicates an array of strings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.Null">
|
|
<summary>
|
|
Indicates null value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.ClipboardData">
|
|
<summary>
|
|
Indicates clipboard data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.AsciiStringArray">
|
|
<summary>
|
|
Indicates an array of strings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.StringArray">
|
|
<summary>
|
|
Indicates an array of strings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CompoundFile.PropertyType.ObjectArray">
|
|
<summary>
|
|
Indicates an array of objects. Supported types are string and integer values.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CompoundFile.IDocProperty">
|
|
<summary>
|
|
Represents a property of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.IsBuiltIn">
|
|
<summary>
|
|
Indicates whether property is built-in. Read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.PropertyId">
|
|
<summary>
|
|
Returns property id for built-in properties. Read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Name">
|
|
<summary>
|
|
Returns property name. Read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Value">
|
|
<summary>
|
|
Gets / sets property value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Boolean">
|
|
<summary>
|
|
Gets / sets boolean value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Integer">
|
|
<summary>
|
|
Gets / sets integer value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Int32">
|
|
<summary>
|
|
Gets / sets 4-bytes signed integer value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Double">
|
|
<summary>
|
|
Gets / sets double value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.Text">
|
|
<summary>
|
|
Gets / sets string value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.DateTime">
|
|
<summary>
|
|
Gets / sets DateTime value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.TimeSpan">
|
|
<summary>
|
|
Gets / sets TimeSpan value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.LinkSource">
|
|
<summary>
|
|
Returns or sets the source of a linked custom document property. Read/write String.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.IDocProperty.LinkToContent">
|
|
<summary>
|
|
True if the value of the custom document property is linked to the content
|
|
of the container document. False if the value is static. Read/write Boolean.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CompoundFile.ClipboardData">
|
|
<summary>
|
|
Represents clipboard data and implements the ICloneable interface for creating a deep copy of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.ClipboardData.Format">
|
|
<summary>
|
|
Clipboard format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CompoundFile.ClipboardData.Data">
|
|
<summary>
|
|
Clipboard data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.CompoundFile.ClipboardData.Clone">
|
|
<summary>
|
|
Createas copy of the current object.
|
|
</summary>
|
|
<returns>A copy of the current object.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.CompoundFile.ClipboardData.Serialize(System.IO.Stream)">
|
|
<summary>
|
|
Saves clipboard data into stream.
|
|
</summary>
|
|
<param name="stream">Stream to write data into.</param>
|
|
<returns>Size of the written data.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.CompoundFile.ClipboardData.Parse(System.IO.Stream)">
|
|
<summary>
|
|
Extracts data from the stream.
|
|
</summary>
|
|
<param name="stream">Stream to get data from.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.CompoundFile.IDocCloneable.Clone">
|
|
<summary>
|
|
Creates a new object that is a copy of the current instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.PermissionCollection">
|
|
<summary>
|
|
A collection of <see cref="T:Spire.Doc.Permission"/> objects that
|
|
represent the permission in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.PermissionCollection.Item(System.String)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Permission"/> with the specified id.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.PermissionCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Permission"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.PermissionCollection.FindById(System.String)">
|
|
<summary>
|
|
Finds <see cref="T:Spire.Doc.Permission"/> object by specified id
|
|
</summary>
|
|
<param name="name">The Permission id</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.PermissionCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes a permission at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.PermissionCollection.Remove(Spire.Doc.Permission)">
|
|
<summary>
|
|
Removes the specified permission.
|
|
</summary>
|
|
<param name="permission">The permission.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.PermissionCollection.Clear">
|
|
<summary>
|
|
Removes all permissions from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ShapeItemCollection">
|
|
<summary>
|
|
Represents a collection for <see cref="T:Spire.Doc.Fields.Shapes.ShapeBase"/> child items.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.BodyRegionCollection">
|
|
<summary>
|
|
Represents a collection for <see cref="T:Spire.Doc.Body"/> child items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.BodyRegionCollection.#ctor(Spire.Doc.Body)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:BodyItemCollection"/> class.
|
|
</summary>
|
|
<param name="body">The body.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.BookmarkCollection">
|
|
<summary>
|
|
A collection of <see cref="T:Spire.Doc.Bookmark"/> objects that
|
|
represent the bookmarks in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.BookmarkCollection.Item(System.String)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Bookmark"/> with the specified name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.BookmarkCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Bookmark"/> at the specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.BookmarkCollection.FindByName(System.String)">
|
|
<summary>
|
|
Finds <see cref="T:Spire.Doc.Bookmark"/> object by specified name
|
|
</summary>
|
|
<param name="name">The bookmark name</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.BookmarkCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes a bookmark at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.BookmarkCollection.Remove(Spire.Doc.Bookmark)">
|
|
<summary>
|
|
Removes the specified bookmark.
|
|
</summary>
|
|
<param name="bookmark">The bookmark.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.BookmarkCollection.Clear">
|
|
<summary>
|
|
Removes all bookmarks from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.CollectionEx">
|
|
<summary>
|
|
This class implements the Collection interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.CollectionEx.Count">
|
|
<summary>
|
|
Gets the number of items in the collection.
|
|
</summary>
|
|
<value>The count.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CollectionEx.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ColumnCollection">
|
|
<summary>
|
|
A collection of <see cref="T:Spire.Doc.Column"/> objects that
|
|
represent all the columns of text in a section of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ColumnCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Column"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ColumnCollection.Add(Spire.Doc.Column)">
|
|
<summary>
|
|
Adds <see cref="T:Spire.Doc.Column"/> object to the collection.
|
|
</summary>
|
|
<param name="column">The column.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ColumnCollection.Populate(System.Int32,System.Single)">
|
|
<summary>
|
|
Populates the specified number of columns with specified spacing.
|
|
</summary>
|
|
<param name="count">The count.</param>
|
|
<param name="spacing">The spacing.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ColumnCollection.Clear">
|
|
<summary>
|
|
Removes all item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.CommentsCollection">
|
|
<summary>
|
|
A collection of <see cref="T:Spire.Doc.Fields.Comment"/> objects that
|
|
represent the comments in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CommentsCollection.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.CommentsCollection"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.CommentsCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the comment at specified index.
|
|
</summary>
|
|
<value></value>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CommentsCollection.Counts">
|
|
<summary>
|
|
Counts this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CommentsCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Remove a Comment at specified index.
|
|
</summary>
|
|
<param name="index"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CommentsCollection.Clear">
|
|
<summary>
|
|
Remove all the Comment from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CommentsCollection.Remove(Spire.Doc.Fields.Comment)">
|
|
<summary>
|
|
Removes the specified Comment.
|
|
</summary>
|
|
<param name="comment"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DocumentObjectCollection">
|
|
<summary>
|
|
Represents a collection of DLS entities.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentObjectCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.DocumentObject"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentObjectCollection.FirstItem">
|
|
<summary>
|
|
Gets the first item.
|
|
</summary>
|
|
<value>The first item.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentObjectCollection.LastItem">
|
|
<summary>
|
|
Gets the last item.
|
|
</summary>
|
|
<value>The last item.</value>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "P:Spire.Doc.Collections.DocumentObjectCollection.Owner" -->
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.Add(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Adds the specified entity.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.Clear">
|
|
<summary>
|
|
Removes all items
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.Contains(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Determines whether a entity is in the collection.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.IndexOf(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Returns the zero-based index of the specified entity.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.Insert(System.Int32,Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Inserts a entity into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<param name="entity">the document object.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.Remove(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Removes the document object from the collection.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the document object at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsType">
|
|
<summary>
|
|
Specifies Item DocumentObject type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsType.Add">
|
|
<summary>
|
|
Add entity type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsType.Remove">
|
|
<summary>
|
|
Remove DocumentObject type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsType.Clear">
|
|
<summary>
|
|
Clear DocumentObject type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DocumentObjectCollection.ChangeItems">
|
|
<summary>
|
|
Eventhandler for DocumentObjectCollection class.
|
|
</summary>
|
|
<param name="type">DocumentObject type.</param>
|
|
<param name="entity">The DocumentObject.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsHandlerList.Add(Spire.Doc.Collections.DocumentObjectCollection.ChangeItems)">
|
|
<summary>
|
|
Adds the specified handler.
|
|
</summary>
|
|
<param name="handler">The handler.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsHandlerList.Remove(Spire.Doc.Collections.DocumentObjectCollection.ChangeItems)">
|
|
<summary>
|
|
Removes the specified handler.
|
|
</summary>
|
|
<param name="handler">The handler.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsHandlerList.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsHandlerList.Send(Spire.Doc.Collections.DocumentObjectCollection.ChangeItemsType,Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Sends the specified type.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<param name="entity">the document object.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DocumentSubsetCollection">
|
|
<summary>
|
|
Represents a subset from collection of specified type entities.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentSubsetCollection.Document">
|
|
<summary>
|
|
Gets the document.
|
|
</summary>
|
|
<value>The document.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentSubsetCollection.Owner">
|
|
<summary>
|
|
Gets the owner.
|
|
</summary>
|
|
<value>The owner.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentSubsetCollection.Count">
|
|
<summary>
|
|
Gets the count.
|
|
</summary>
|
|
<value>The count.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentSubsetCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.DocumentObject"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentSubsetCollection.Clear">
|
|
<summary>
|
|
Removes all entities
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentSubsetCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator">
|
|
<summary>
|
|
Represents a internal enumerator for EntitySubSetCollection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator.#ctor(Spire.Doc.Collections.DocumentSubsetCollection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator"/> class.
|
|
</summary>
|
|
<param name="enColl">The entities collection.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator.Current">
|
|
<summary>
|
|
Gets the current element in the collection.
|
|
</summary>
|
|
<value></value>
|
|
<returns>The current element in the collection.</returns>
|
|
<exception cref="T:System.InvalidOperationException">The enumerator is positioned before the first element of the collection or after the last element. </exception>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the collection.
|
|
</summary>
|
|
<returns>
|
|
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DocumentSubsetCollection.SubSetEnumerator.Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element in the collection.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.FieldCollection">
|
|
<summary>
|
|
A collection objects that
|
|
represent the fields in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.FieldCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the field at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.FormFieldCollection">
|
|
<summary>
|
|
Represents a collection of form fields.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.FormFieldCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.FormField"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.FormFieldCollection.Item(System.String)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.FormField"/> by specified form field name.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.FormFieldCollection.ContainsName(System.String)">
|
|
<summary>
|
|
Determines whether the specified collection contains item with specified name.
|
|
</summary>
|
|
<param name="itemName">Name of the item.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ListLevelCollection">
|
|
<summary>
|
|
Represents a collections of list formatting for each level in a list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ListLevelCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the ListLevel at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The zero-based index of the ListLevel to retrieve.</param>
|
|
<returns>The ListLevel object located at the specified index in the collection.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ListCollection">
|
|
<summary>
|
|
Represents a collection of list reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ListCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ListStyle"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ListCollection.Add(Spire.Doc.Documents.ListTemplate)">
|
|
<summary>
|
|
Creates a new list using the specified template and returns a reference to it.
|
|
</summary>
|
|
<param name="template">The template used to create the new list.</param>
|
|
<returns>
|
|
A reference to the newly created list.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ListCollection.AddSingleLevelList(Spire.Doc.Documents.ListTemplate)">
|
|
<summary>
|
|
Creates a single-level list using the specified list template and adds it to the current context.
|
|
</summary>
|
|
<param name="listTemplate">The list template used to create the single level list.</param>
|
|
<returns>
|
|
A ListReference representing the newly created single level list.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ListCollection.FindByName(System.String)">
|
|
<summary>
|
|
Finds list style by name.
|
|
</summary>
|
|
<param name="listDefName">The name to search for in the list definitions.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ParagraphItemCollection">
|
|
<summary>
|
|
Represents a collection for <see cref="!:Spire.Doc.Paragraph"/> child items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ParagraphItemCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ParagraphBase"/> at the specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ParagraphItemCollection.TypesOfElement">
|
|
<summary>
|
|
Gets the types of elements that are contained in this collection.
|
|
</summary>
|
|
<returns>An array of System.Type containing the types of elements that are contained in this collection.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphItemCollection.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.ParagraphItemCollection"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.StyleCollection">
|
|
<summary>
|
|
Represents a collection of styles that can be serialized to a document and implements the IStyleCollection interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.StyleCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.Add(Spire.Doc.Interface.IStyle)">
|
|
<summary>
|
|
Adds Style to collection
|
|
</summary>
|
|
<param name="style">The style.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.Add(Spire.Doc.Documents.StyleType,System.String)">
|
|
<summary>
|
|
Adds a new style to the collection.
|
|
</summary>
|
|
<param name="type">The type of style to create.</param>
|
|
<param name="name">The name of the style.</param>
|
|
<returns>
|
|
The newly created style.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.Add(Spire.Doc.Documents.ListType,System.String)">
|
|
<summary>
|
|
Adds a new list style to the collection.
|
|
</summary>
|
|
<param name="listType">The type of list to create (e.g., bulleted or numbered).</param>
|
|
<param name="name">The name of the list style. Must contain characters.</param>
|
|
<returns>The newly created ListStyle object.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.FindByName(System.String)">
|
|
<summary>
|
|
Finds Style by name
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.FindByName(System.String,Spire.Doc.Documents.StyleType)">
|
|
<summary>
|
|
Finds Style by name
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="styleType">Type of the style.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.FindById(System.Int32)">
|
|
<summary>
|
|
Finds Style by id
|
|
</summary>
|
|
<param name="styleId">The style id.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.FindByIstd(System.Int32)">
|
|
<summary>
|
|
Finds Style by istd.
|
|
</summary>
|
|
<param name="istd">The style istd.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.StyleCollection.FindByIdentifier(System.Int32)">
|
|
<summary>
|
|
Finds Style by identifier
|
|
</summary>
|
|
<param name="sIdentifier">The style identifier.
|
|
The parameter value is the <see cref="T:Spire.Doc.Documents.BuiltinStyle"/> enumeration value
|
|
or the <see cref="T:Spire.Doc.Documents.DefaultTableStyle"/> enumeration value.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.TabCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="T:Spire.Doc.Tab"/> objects
|
|
for paragraph or paragraph format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.TabCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Tab"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.AddTab">
|
|
<summary>
|
|
Adds the tab.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.AddTab(System.Single,Spire.Doc.Documents.TabJustification,Spire.Doc.Documents.TabLeader)">
|
|
<summary>
|
|
Adds the tab.
|
|
</summary>
|
|
<param name="position">The position.</param>
|
|
<param name="justification">The justification.</param>
|
|
<param name="leader">The leader.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.AddTab(System.Single)">
|
|
<summary>
|
|
Adds the tab.
|
|
</summary>
|
|
<param name="position">The position.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.Clear">
|
|
<summary>
|
|
Removes all the tabs from the tab collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the tab at the specified index from the tab collection
|
|
</summary>
|
|
<param name="index"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified object is equal to the current object.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns>true if the specified object is equal to the current object; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TabCollection.Equals(Spire.Doc.Collections.TabCollection)">
|
|
<summary>
|
|
Determines whether the specified TabCollection is equal to the current TabCollection.
|
|
</summary>
|
|
<param name="other">The TabCollection to compare with the current TabCollection.</param>
|
|
<returns>true if the specified TabCollection is equal to the current TabCollection; otherwise, false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.TextBoxCollection">
|
|
<summary>
|
|
Summary description for TextBoxCollection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.TextBoxCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the textbox at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TextBoxCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes a textbox at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TextBoxCollection.Clear">
|
|
<summary>
|
|
Removes all textboxes from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.CellCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="T:Spire.Doc.TableCell"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.CellCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.TableCell"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.CellCollection.TypesOfElement">
|
|
<summary>
|
|
Gets the types of elements for the current instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.#ctor(Spire.Doc.TableRow)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.CellCollection"/> class.
|
|
</summary>
|
|
<param name="owner">The owner.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.Add(Spire.Doc.TableCell)">
|
|
<summary>
|
|
Adds the specified cell.
|
|
</summary>
|
|
<param name="cell">The cell.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.Insert(System.Int32,Spire.Doc.TableCell)">
|
|
<summary>
|
|
Inserts a specified table cell into collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<param name="cell">The cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.IndexOf(Spire.Doc.TableCell)">
|
|
<summary>
|
|
Returns index of a specified cell in collection.
|
|
</summary>
|
|
<param name="cell">The cell.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.Remove(Spire.Doc.TableCell)">
|
|
<summary>
|
|
Removes the specified cell.
|
|
</summary>
|
|
<param name="cell">The cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.CellCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the document object at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.DropDownCollection">
|
|
<summary>
|
|
Represent a collection of <see cref="T:Spire.Doc.Documents.DropDownItem"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.DropDownCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.DropDownItem"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DropDownCollection.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.DropDownCollection"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DropDownCollection.Add(System.String)">
|
|
<summary>
|
|
Adds the item.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DropDownCollection.Remove(System.Int32)">
|
|
<summary>
|
|
Removes DropDownItems by index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.DropDownCollection.Clear">
|
|
<summary>
|
|
Clears this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.ParagraphCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.IParagraph"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.ParagraphCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.IParagraph"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.#ctor(Spire.Doc.Collections.BodyRegionCollection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.ParagraphCollection"/> class.
|
|
</summary>
|
|
<param name="bodyItems">The body items.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.Add(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Adds a paragraph to end of text body.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.Contains(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Determines whether the <see cref="!:Spire.Doc.IParagraphCollection"/> contains a specific value.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<returns>
|
|
If paragraph is found, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.Insert(System.Int32,Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Inserts a paragraph into collection at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<param name="paragraph">The paragraph.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.IndexOf(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Returns the zero-based index of the specified paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.Remove(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Removes the specified paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.ParagraphCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the paragraph at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.RowCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="T:Spire.Doc.TableRow"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.RowCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.TableRow"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.RowCollection.TypesOfElement">
|
|
<summary>
|
|
Gets the types of elements associated with the current instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.RowCollection.#ctor(Spire.Doc.Table)">
|
|
<summary>
|
|
Initializes a new instance of the RowCollection class.
|
|
</summary>
|
|
<param name="owner">The table that owns this row collection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.RowCollection.Add(Spire.Doc.TableRow)">
|
|
<summary>
|
|
Adds a TableRow to the collection and notifies any listeners of the change.
|
|
</summary>
|
|
<param name="row">The TableRow to add.</param>
|
|
<returns>The index at which the TableRow was added.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.RowCollection.Insert(System.Int32,Spire.Doc.TableRow)">
|
|
<summary>
|
|
Inserts a TableRow into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index at which the TableRow should be inserted.</param>
|
|
<param name="row">The TableRow to insert.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.RowCollection.IndexOf(Spire.Doc.TableRow)">
|
|
<summary>
|
|
Retrieves the index of the specified TableRow within the collection.
|
|
</summary>
|
|
<param name="row">The TableRow to locate in the collection.</param>
|
|
<returns>The zero-based index of the TableRow if found; otherwise, -1.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.RowCollection.Remove(Spire.Doc.TableRow)">
|
|
<summary>
|
|
Removes a TableRow from the collection.
|
|
</summary>
|
|
<param name="row">The TableRow to remove.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.SectionCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="T:Spire.Doc.Section"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.SectionCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Section"/> at the specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.SectionCollection.TypesOfElement">
|
|
<summary>
|
|
Gets the array of System.Type objects representing the types of elements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.SectionCollection.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.SectionCollection"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.SectionCollection.Add(Spire.Doc.Interface.ISection)">
|
|
<summary>
|
|
Adds a section to end of document.
|
|
</summary>
|
|
<param name="section">The section.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.SectionCollection.IndexOf(Spire.Doc.Interface.ISection)">
|
|
<summary>
|
|
Returns the zero-based index of the specified section.
|
|
</summary>
|
|
<param name="section">The section.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Collections.TableCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.ITable"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Collections.TableCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ITable"/> at the specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.#ctor(Spire.Doc.Collections.BodyRegionCollection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Collections.TableCollection"/> class.
|
|
</summary>
|
|
<param name="bodyItems">The body items.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.Add(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Adds a table to end of text body.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.Contains(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Determines whether the <see cref="!:Spire.Doc.ITableCollection"/> contains a specific value.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns>
|
|
If table found, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.IndexOf(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Determines the index of a specific item in the <see cref="!:Spire.Doc.ITableCollection"/>.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.Insert(System.Int32,Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Inserts a table into collection at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<param name="table">The table.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.Remove(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Removes the specified table.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Collections.TableCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the table at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BookmarksNavigator">
|
|
<summary>
|
|
Helper class for navigations in document bookmarks and editing bookmarks content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.BookmarksNavigator.Document">
|
|
<summary>
|
|
Returns or setsDocument that this object is attached to.
|
|
</summary>
|
|
<value>The document.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.BookmarksNavigator.CurrentBookmark">
|
|
<summary>
|
|
Gets the current bookmark.
|
|
</summary>
|
|
<value>The current bookmark.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:BookmarksNavigator"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.MoveToBookmark(System.String)">
|
|
<summary>
|
|
Moves the cursor to specified bookmark.
|
|
</summary>
|
|
<param name="bookmarkName">Name of the bookmark.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.MoveToBookmark(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Moves the cursor to specified bookmark.
|
|
</summary>
|
|
<param name="bookmarkName">Name of the bookmark.</param>
|
|
<param name="isStart">When true, moves the cursor to the beginning of the bookmark. When false, moves the cursor to the end of the bookmark</param>
|
|
<param name="isAfter">When true, moves the cursor to be after the bookmark start or end position. When false, moves the cursor to be before the bookmark start or end position. </param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertText(System.String)">
|
|
<summary>
|
|
Inserts the text.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertText(System.String,System.Boolean)">
|
|
<summary>
|
|
Inserts the text range to current position.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
<param name="saveFormatting">if it is save formatting, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertTable(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Inserts the table.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertParagraphItem(Spire.Doc.Documents.ParagraphItemType)">
|
|
<summary>
|
|
Inserts the paragraph item to current position.
|
|
</summary>
|
|
<param name="itemType">Type of the item.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertParagraph(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Inserts the paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.InsertTextBodyPart(Spire.Doc.Documents.TextBodyPart)">
|
|
<summary>
|
|
Inserts the text body part.
|
|
</summary>
|
|
<param name="bodyPart">The text body part.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.GetBookmarkContent">
|
|
<summary>
|
|
Gets the bookmark content2.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.DeleteBookmarkContent(System.Boolean)">
|
|
<summary>
|
|
Deletes the bookmark content.
|
|
</summary>
|
|
<param name="saveFormatting">if its save formatting, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.ReplaceBookmarkContent(Spire.Doc.Documents.TextBodyPart)">
|
|
<summary>
|
|
Replaces the bookmark content with the specified TextBodyPart object.
|
|
</summary>
|
|
<param name="bodyPart">The body part.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.ReplaceBookmarkContent(Spire.Doc.Documents.TextBodyPart,System.Boolean)">
|
|
<summary>
|
|
Replaces the bookmark content with specified TextBodyPart object,
|
|
with an option to preserve the formatting of the first paragraph
|
|
in the source content.
|
|
</summary>
|
|
<param name="bodyPart">The body part.</param>
|
|
<param name="isKeepSourceFormat">if it is keep the source first paragraph format, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.ReplaceBookmarkContent(Spire.Doc.Documents.TextBodyPart,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces the content of the bookmark.
|
|
</summary>
|
|
<param name="bodyPart">The body part.</param>
|
|
<param name="isKeepSourceFirstParaFormat">if it is keep the source first paragraph format, set to <c>true</c>.</param>
|
|
<param name="saveFormatting">if it is save formatting, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.BookmarksNavigator.ReplaceBookmarkContent(System.String,System.Boolean)">
|
|
<summary>
|
|
Replaces the content of the bookmark with new text.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
<param name="saveFormatting">if it is save formatting, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Comparison.CompareOptions">
|
|
<summary>
|
|
Document comparison parameter settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Comparison.CompareOptions.IgnoreFormatting">
|
|
<summary>
|
|
Gets or sets a value indicating whether to ignore format comparisons when comparing documents.
|
|
The default is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Comparison.CompareOptions.TextCompareLevel">
|
|
<summary>
|
|
Gets or sets the text compare level.
|
|
Default value is <see cref="F:Spire.Doc.Documents.Comparison.TextDiffMode.Word" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Comparison.CompareOptions.IgnoreHeadersAndFooters">
|
|
<summary>
|
|
Gets or sets a value indicating whether to ignore headers and footers comparisons when comparing documents.
|
|
The default is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Comparison.CompareOptions.IgnoreTable">
|
|
<summary>
|
|
Gets or sets a value indicating whether to ignore table comparisons when comparing documents.
|
|
The default is false.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Comparison.TextDiffMode">
|
|
<summary>
|
|
Specifies types of comparison.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Comparison.TextDiffMode.Char">
|
|
<summary>
|
|
Character level comparison.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Comparison.TextDiffMode.Word">
|
|
<summary>
|
|
Word level comparison.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Converters.Html.Writer.HtmlTreePostActionBase">
|
|
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Converters.Export.HtmlExportListLabelsType">
|
|
<summary>
|
|
Represents the type of the HTML export list labels type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Converters.Export.HtmlExportListLabelsType.Auto">
|
|
<summary>
|
|
Specifies Auto list labels type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Converters.Export.HtmlExportListLabelsType.InlineText">
|
|
<summary>
|
|
Specifies InlineText list labels type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Converters.Export.HtmlExportListLabelsType.HtmlTags">
|
|
<summary>
|
|
Specifies HtmlTags list labels type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Converters.GridTable">
|
|
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Borders">
|
|
<summary>
|
|
Represents a collection of the border. <see cref="!:Spire.Doc.Border"/>
|
|
<para>
|
|
When dealing with page borders and image borders, only four basic border options are provided: left border, top border, right border and bottom border.
|
|
Any attempt to apply border designs beyond these four basic styles will result in the system issuing error notifications, ensuring that your actions comply with established rules.
|
|
</para>
|
|
<para>
|
|
When dealing with paragraph borders and table borders, only six basic border options are provided: left border, top border, right border, bottom border, horizontal border and vertical border.
|
|
Any attempt to apply border designs beyond these six basic styles will result in the system issuing error notifications, ensuring that your actions comply with established rules.
|
|
</para>
|
|
<para>
|
|
When dealing with cell borders, only six basic border options are provided: left border, top border, right border, bottom border, diagonalDown border and diagonalUp border.
|
|
Any attempt to apply border designs beyond these six basic styles will result in the system issuing error notifications, ensuring that your actions comply with established rules.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Borders.ClearFormatting">
|
|
<summary>
|
|
Clears formatting for each border in the borders.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Borders.SetBordersAttribute(Spire.Doc.Documents.BorderStyle,System.Single,System.Drawing.Color)">
|
|
<summary>
|
|
Sets the border attributes for the specified border type, line width, and color.
|
|
</summary>
|
|
<param name="borderType">The type of border to set.</param>
|
|
<param name="lineWidth">The width of the border line.</param>
|
|
<param name="color">The color of the border.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Item(Spire.Doc.Formatting.BorderPositions)">
|
|
<summary>
|
|
This indexer provides access to the border property based on the specified border position.
|
|
</summary>
|
|
<param name="borderPos">The position of the border to retrieve.</param>
|
|
<returns>The border object associated with the given position.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Item(System.Int32)">
|
|
<summary>
|
|
This indexer provides access to the border property based on the index.
|
|
</summary>
|
|
<param name="index">The index of the border to retrieve.</param>
|
|
<returns>The border object associated with the given index.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Left">
|
|
<summary>
|
|
Gets left border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Right">
|
|
<summary>
|
|
Gets right border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Top">
|
|
<summary>
|
|
Gets top border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Bottom">
|
|
<summary>
|
|
Gets bottom border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Horizontal">
|
|
<summary>
|
|
Gets horizontal border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Vertical">
|
|
<summary>
|
|
Gets vertical border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.DiagonalUp">
|
|
<summary>
|
|
Gets the border applied diagonally upwards.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.DiagonalDown">
|
|
<summary>
|
|
Gets the border applied diagonally downwards.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Count">
|
|
<summary>
|
|
Gets the total number of possible border positions available for this borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.LineWidth">
|
|
<summary>
|
|
Gets or sets width of the borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.BorderType">
|
|
<summary>
|
|
Sets style of the borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Color">
|
|
<summary>
|
|
Gets or sets color of the borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.NoBorder">
|
|
<summary>
|
|
Gets whether the border exists
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.Space">
|
|
<summary>
|
|
Gets or sets the width of space to maintain between borders and text within borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Borders.IsShadow">
|
|
<summary>
|
|
Gets or sets whether borders are drawn with shadow.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ICellAttrSource.FetchCellAttrWithoutDefault(System.Int32)">
|
|
<summary>
|
|
Fetches the attribute of a cell without using a default value, based on the provided key.
|
|
</summary>
|
|
<param name="key">The key associated with the cell attribute to fetch.</param>
|
|
<returns>The attribute of the cell if found; otherwise, null or an appropriate default value indicating the attribute is not present.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.DropDownItem">
|
|
<summary>
|
|
Represents the item of drop down formfield.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.DropDownItem.Text">
|
|
<summary>
|
|
Gets or sets text
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.DropDownItem.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.DropDownItem"/> class.
|
|
</summary>
|
|
<param name="doc">The document</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Paragraph">
|
|
<summary>
|
|
Represents a paragraph of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.ListText">
|
|
<summary>
|
|
Gets the list text.
|
|
The value of the list number is obtained by dynamic calculation.
|
|
The value of the list number of the paragraph directly may be incorrect.
|
|
To obtain the correct value, you need to traverse all paragraphs in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.ChildObjects">
|
|
<summary>
|
|
Gets the child objects.
|
|
</summary>
|
|
<value>The child objects.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.StyleName">
|
|
<summary>
|
|
Gets paragraph style name.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.Text">
|
|
<summary>
|
|
Returns or sets paragraph text.
|
|
</summary>
|
|
<value></value>
|
|
<remarks>All internal formatting will be cleared when new text is set.</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.Item(System.Int32)">
|
|
<summary>
|
|
Gets paragraph item by index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.Items">
|
|
<summary>
|
|
Gets paragraph items.
|
|
</summary>
|
|
<value>The items.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.Format">
|
|
<summary>
|
|
Gets paragraph format.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.BreakCharacterFormat">
|
|
<summary>
|
|
Gets character format for the break symbol.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.ListFormat">
|
|
<summary>
|
|
Gets list format of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.Frame">
|
|
<summary>
|
|
Gets frame format of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.IsInCell">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is in cell.
|
|
</summary>
|
|
<value>
|
|
if this paragraph is in cell, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.IsEndOfSection">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is end of section.
|
|
</summary>
|
|
<value>
|
|
if this paragraph is end of section, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.IsEndOfHeaderFooter">
|
|
<summary>
|
|
True if this paragraph is the last paragraph in the <b>HeaderFooter</b> (main text story) of a <b>Section</b>; false otherwise.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.IsEndOfDocument">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is end of document.
|
|
</summary>
|
|
<value>
|
|
if this instance is end of document, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.WordCount">
|
|
<summary>
|
|
Gets the word count.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.CharCount">
|
|
<summary>
|
|
Gets the char count,whtout spaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.CharCountIncludeSpace">
|
|
<summary>
|
|
Gets the char count of the include spaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Paragraph.ParentSection">
|
|
<summary>
|
|
Gets the parent section of the current paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.Paragraph"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.ApplyStyle(System.String)">
|
|
<summary>
|
|
Applies the specified style.
|
|
</summary>
|
|
<param name="styleName">Style name</param>
|
|
<remarks>Specified style must exist in Document.Styles collection</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.ApplyStyle(Spire.Doc.Documents.BuiltinStyle)">
|
|
<summary>
|
|
Applies the built-in style.
|
|
</summary>
|
|
<param name="builtinStyle">The built-in style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.ApplyStyle(Spire.Doc.Interface.IParagraphStyle)">
|
|
<summary>
|
|
Applies the specified style.
|
|
</summary>
|
|
<param name="style">The paragraph style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.GetStyle">
|
|
<summary>
|
|
Gets related style.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendText(System.String)">
|
|
<summary>
|
|
Appends text to end of document.
|
|
</summary>
|
|
<param name="text"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPicture(System.Byte[])">
|
|
<summary>
|
|
Appends image to end of paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendField(System.String,Spire.Doc.FieldType)">
|
|
<summary>
|
|
Appends the field.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendFieldMark(Spire.Doc.Documents.FieldMarkType)">
|
|
<summary>
|
|
Appends the field mark.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendHyperlink(System.String,System.String,Spire.Doc.Documents.HyperlinkType)">
|
|
<summary>
|
|
Appends the hyperlink.
|
|
</summary>
|
|
<param name="link">The link.</param>
|
|
<param name="text">The text to display.</param>
|
|
<param name="type">The hyperlink type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendHyperlink(System.String,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.HyperlinkType)">
|
|
<summary>
|
|
Appends the hyperlink.
|
|
</summary>
|
|
<param name="link">The link.</param>
|
|
<param name="picture">The picture to display.</param>
|
|
<param name="type">The type of hyperlink.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendBookmarkStart(System.String)">
|
|
<summary>
|
|
Appends start of the bookmark with specified name into paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendBookmarkEnd(System.String)">
|
|
<summary>
|
|
Appends end of the bookmark with specified name into paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPermStart(System.String)">
|
|
<summary>
|
|
Appends start of the permission with specified id into paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPermEnd(System.String)">
|
|
<summary>
|
|
Appends end of the permission with specified id into paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendComment(System.String)">
|
|
<summary>
|
|
Appends the comment.
|
|
</summary>
|
|
<param name="text">The string.</param>
|
|
<returns>Returns WComment.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendCommentMark(Spire.Doc.Documents.CommentMarkType)">
|
|
<summary>
|
|
Appends the comment mark.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<returns>Returns CommentMark.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendFootnote(Spire.Doc.FootnoteType)">
|
|
<summary>
|
|
Appends the footnote.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<returns>returns the footnotes.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendFootnote(Spire.Doc.FootnoteType,System.Boolean)">
|
|
<summary>
|
|
Appends the footnote.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<param name="bIsAutoNumbered">Is auto numbered.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendTextBox(System.Single,System.Single)">
|
|
<summary>
|
|
Append Textbox to the end of the paragraph
|
|
</summary>
|
|
<param name="width">Textbox width</param>
|
|
<param name="height">Textbox height</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendCheckBox">
|
|
<summary>
|
|
Appends the check box form field.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendCheckBox(System.String,System.Boolean)">
|
|
<summary>
|
|
Appends the check box.
|
|
</summary>
|
|
<param name="checkBoxName">Name of the check box.</param>
|
|
<param name="defaultCheckBoxValue">Default checkbox value</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendTextFormField(System.String)">
|
|
<summary>
|
|
Appends the text form field.
|
|
</summary>
|
|
<param name="defaultText">The default text. Pass "null" to insert default Word text</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendTextFormField(System.String,System.String)">
|
|
<summary>
|
|
Appends the text form field.
|
|
</summary>
|
|
<param name="formFieldName">Name of the form field.</param>
|
|
<param name="defaultText">The default text. Pass "null" to insert default Word text</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendDropDownFormField">
|
|
<summary>
|
|
Appends the drop down form field.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendDropDownFormField(System.String)">
|
|
<summary>
|
|
Appends the drop down form field.
|
|
</summary>
|
|
<param name="dropDropDownName">Name of the drop drop down.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendSymbol(System.Byte)">
|
|
<summary>
|
|
Appends special symbol to end of paragraph.
|
|
</summary>
|
|
<param name="characterCode">The character code.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendShape(System.Single,System.Single,Spire.Doc.Documents.ShapeType)">
|
|
<summary>
|
|
Append Shape to the end of the paragraph.
|
|
</summary>
|
|
<param name="width">Shape width</param>
|
|
<param name="height">Shape height</param>
|
|
<param name="shapeType">Shape type</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendHorizonalLine">
|
|
<summary>
|
|
Append Horizonal Line to the end of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendShapeGroup(System.Single,System.Single)">
|
|
<summary>
|
|
Append shape Group to the end of the paragraph.
|
|
</summary>
|
|
<param name="width">The width.</param>
|
|
<param name="height">The height.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendChart(Spire.Doc.Fields.Shapes.Charts.ChartType,System.Single,System.Single)">
|
|
<summary>
|
|
Append an chart object into the document and scales it to the specified size.
|
|
</summary>
|
|
<param name="chartType">The chart type to insert into the document.</param>
|
|
<param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<returns>The image node that was just inserted.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendChart(Spire.Doc.Fields.Shapes.Charts.ChartType,Spire.Doc.Documents.HorizontalOrigin,System.Single,Spire.Doc.Documents.VerticalOrigin,System.Single,System.Single,System.Single,Spire.Doc.Documents.TextWrappingStyle)">
|
|
<summary>
|
|
Append an chart object into the document and scales it to the specified size.
|
|
</summary>
|
|
<param name="chartType">The chart type to insert into the document.</param>
|
|
<param name="horzPos">Specifies where the distance to the image is measured from.</param>
|
|
<param name="left">Distance in points from the origin to the left side of the image.</param>
|
|
<param name="vertPos">Specifies where the distance to the image measured from.</param>
|
|
<param name="top">Distance in points from the origin to the top side of the image.</param>
|
|
<param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<param name="wrapType">Specifies how to wrap text around the image.</param>
|
|
<returns>The image node that was just inserted.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendBreak(Spire.Doc.Documents.BreakType)">
|
|
<summary>
|
|
Appends break to end of paragraph.
|
|
</summary>
|
|
<param name="breakType">The break type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendTOC(System.Int32,System.Int32)">
|
|
<summary>
|
|
Appends the table of content.
|
|
</summary>
|
|
<param name="lowerLevel">The starting heading level of the table of content.</param>
|
|
<param name="upperLevel">The ending heading level of the table of content.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPicture(System.Drawing.Image)">
|
|
<summary>
|
|
Appends a picture to the document.
|
|
</summary>
|
|
<param name="image">The image to append.</param>
|
|
<returns>The document with the appended picture.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPicture(System.String)">
|
|
<summary>
|
|
Appends the picture.
|
|
</summary>
|
|
<param name="imgFile">The img file.</param>
|
|
<returns>DocPicture.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendPicture(System.IO.Stream)">
|
|
<summary>
|
|
Appends the picture.
|
|
</summary>
|
|
<param name="imgStream">The img stream.</param>
|
|
<returns>DocPicture.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendHTML(System.String)">
|
|
<summary>
|
|
Appends the HTML.
|
|
</summary>
|
|
<param name="html">The HTML.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendRTF(System.String,System.Boolean)">
|
|
<summary>
|
|
Appends the RTF.
|
|
</summary>
|
|
<param name="rtfcode">the RTF code.</param>
|
|
<param name="addtolastsection">When is true, added to the last section of the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendRTF(System.String)">
|
|
<summary>
|
|
Appends the RTF.
|
|
</summary>
|
|
<param name="rtfCode">The RTF code.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="oleStorage">The OLE object (file) stream.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="type">The type of OLE object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object into paragraph.
|
|
</summary>
|
|
<param name="oleBytes">The OLE object (file) bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="type">The type of OLE object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.String,System.String,System.Byte[],Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Appends the OLE object into paragraph.
|
|
</summary>
|
|
<param name="progId">The programmatic identifier.</param>
|
|
<param name="clsId">The class identifier.</param>
|
|
<param name="nativeData">The native data of embedded OLE object.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.String,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object into paragraph.
|
|
</summary>
|
|
<param name="pathToFile">The path to file.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="type">The type of OLE object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.String,Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="pathToFile">The path to file.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleLinkType)">
|
|
<summary>
|
|
Appends the OLE object into paragraph.
|
|
</summary>
|
|
<param name="oleStorage">The OLE storage.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleLinkType">The type of OLE object link type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleLinkType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="oleBytes">The OLE storage bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleLinkType">Type of the OLE link.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.String,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleLinkType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="linkFile">The link file. </param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleLinkType">Type of the OLE link.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,System.String)">
|
|
<summary>
|
|
Appends the package OLE object (ole object without specified type).
|
|
</summary>
|
|
<param name="oleBytes">The OLE object bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="fileExtension">The file extension.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,System.String)">
|
|
<summary>
|
|
Appends the package OLE object (ole object without specified type).
|
|
</summary>
|
|
<param name="oleStream">The OLE file stream.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="fileExtension">The file extension.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.RemoveFrame">
|
|
<summary>
|
|
Remove a frame.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.Find(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Returns first entry of matchString regex.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.Find(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Returns first entry of matchString string, taking into consideration caseSensitive
|
|
and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="caseSensitive">if it is case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.FindAllString(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds all occurrences of a specified string within the text, with options for case sensitivity and whole word matching.
|
|
</summary>
|
|
<param name="given">The string to search for.</param>
|
|
<param name="caseSensitive">Indicates whether the search should be case sensitive.</param>
|
|
<param name="wholeWord">Indicates whether the search should match whole words only.</param>
|
|
<returns>An array of TextSelection objects representing all occurrences of the specified string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.FindAllPattern(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds all occurrences of the specified regex pattern in the text and returns them as an array of TextSelection.
|
|
</summary>
|
|
<param name="regex">The regex pattern to search for.</param>
|
|
<returns>An array of TextSelection representing all occurrences of the pattern in the text, or null if no occurrences are found or the pattern is empty or null.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.InsertSectionBreak">
|
|
<summary>
|
|
Inserts the section break.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.InsertSectionBreak(Spire.Doc.Documents.SectionBreakType)">
|
|
<summary>
|
|
Inserts the section break.
|
|
</summary>
|
|
<param name="breakType">Type of the break.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.UpdateWordCount(System.Char[],System.Boolean)">
|
|
<summary>
|
|
Calculate word count and character count of the paragraph.
|
|
</summary>
|
|
<param name="splitchar"></param>
|
|
<param name="includeTB"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.GetText(System.Boolean)">
|
|
<summary>
|
|
Get the paragraph text.
|
|
</summary>
|
|
<param name="isShowFieldText">If isShowFieldText is true,get the paragraph Text with the field text,else get the paragraph Text with the field code</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.UpdateListValue">
|
|
<summary>
|
|
Updates the list value.
|
|
The value of the list number is obtained by dynamic calculation.
|
|
The value of the list number of the paragraph directly may be incorrect.
|
|
To obtain the correct value, you need to traverse all paragraphs in the document.
|
|
</summary>
|
|
<returns>the value string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.GetListFormatForApplyStyle">
|
|
<summary>
|
|
Gets the list format for apply style.
|
|
</summary>
|
|
<returns>the list format.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Paragraph.GetIndex(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Returns the zero-based index of the specified entity.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.DLSException">
|
|
<summary>
|
|
Represents general exception in DLS library.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.DLSException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.DLSException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.DLSException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.DLSException"/> class.
|
|
</summary>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.DLSException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.DLSException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.DLSException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.DLSException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.HtmlConverterRegisterException">
|
|
<summary>
|
|
Summary description for HTMLConverterRegisterException.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.HtmlConverterRegisterException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.HtmlConverterRegisterException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.HtmlConverterRegisterException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.HtmlConverterRegisterException"/> class.
|
|
</summary>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.HtmlConverterRegisterException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.HtmlConverterRegisterException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.HtmlConverterRegisterException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.HtmlConverterRegisterException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.IWSectionCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.ISection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.IWSectionCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ISection"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IWSectionCollection.Add(Spire.Doc.Interface.ISection)">
|
|
<summary>
|
|
Adds a section to end of document.
|
|
</summary>
|
|
<param name="section">The section.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IWSectionCollection.IndexOf(Spire.Doc.Interface.ISection)">
|
|
<summary>
|
|
Returns the zero-based index of the specified section.
|
|
</summary>
|
|
<param name="section">The section.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.IBodyRegion">
|
|
<summary>
|
|
Interface publishes Body Region Interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IBodyRegion.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
<param name="newValue"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IBodyRegion.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces by specified matchString string.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IBodyRegion.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.IStructureDocument">
|
|
<summary>
|
|
Represents a structure document that can be composed of other objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.IStructureDocument.SDTProperties">
|
|
<summary>
|
|
Get the Sdt properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.IStructureDocument.BreakCharacterFormat">
|
|
<summary>
|
|
Get the character format of the break.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.IStructureDocument.UpdateDataBinding">
|
|
<summary>
|
|
Updates stuctured documnet tag content with bound data.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:Spire.Doc.Documents.IStructureDocument.RemoveSelfOnly" -->
|
|
<member name="T:Spire.Doc.Documents.Markup.CustomXmlPart">
|
|
<summary>
|
|
Represents a Custom XML Data Storage Part (custom XML data within a package).
|
|
</summary>
|
|
<remarks>
|
|
<para>A OOML or DOC document can contain one or more Custom XML Data Storage parts. Spire.Words preserves and
|
|
allows to create and extract Custom XML Data via the <see cref="P:Spire.Doc.Document.CustomXmlParts"/> collection.</para>
|
|
|
|
<seealso cref="P:Spire.Doc.Document.CustomXmlParts"/>
|
|
<seealso cref="T:Spire.Doc.Documents.Markup.CustomXmlPartCollection"/>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPart.#ctor">
|
|
<summary>
|
|
Initializes an instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Markup.CustomXmlPart.Id">
|
|
<summary>
|
|
Gets or sets the string that identifies this custom XML part within an OOXML document.
|
|
</summary>
|
|
<remarks>
|
|
<para>ISO/IEC 29500 specifies that this value is a GUID, but Microsoft Word seems to allow any string
|
|
value for this property and Spire.Words does the same. A valid value must be an identifier that is
|
|
unique among all custom XML data parts in this document.</para>
|
|
|
|
<para>The default value is an empty string. The value cannot be <c>null</c>.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Markup.CustomXmlPart.Data">
|
|
<summary>
|
|
Gets or sets the XML content of this Custom XML Data Storage Part.
|
|
</summary>
|
|
<remarks>
|
|
<para>The default value is an empty byte array. The value cannot be <c>null</c>.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPart.Clone">
|
|
<summary>
|
|
Makes a "deep enough" copy of the object.
|
|
Does not duplicate the bytes of the <see cref="P:Spire.Doc.Documents.Markup.CustomXmlPart.Data"/> value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Markup.CustomXmlPartCollection">
|
|
<summary>
|
|
Represents a collection of Custom XML Parts. The items are <see cref="T:Spire.Doc.Documents.Markup.CustomXmlPart"/> objects.
|
|
</summary>
|
|
<remarks>
|
|
<para>You do not normally need to create instances of this class. You can access custom XML data
|
|
stored in a document via the <see cref="P:Spire.Doc.Document.CustomXmlParts"/> property.
|
|
</para>
|
|
|
|
<seealso cref="T:Spire.Doc.Documents.Markup.CustomXmlPart"/>
|
|
<seealso cref="P:Spire.Doc.Document.CustomXmlParts"/>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes an instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Markup.CustomXmlPartCollection.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Markup.CustomXmlPartCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets an item at the specified index.
|
|
</summary>
|
|
<param name="index">Zero-based index of the item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an <ms>enumerator</ms><java>iterator</java> object that can be used to iterate over all items in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.Add(Spire.Doc.Documents.Markup.CustomXmlPart)">
|
|
<summary>
|
|
Adds an item to the collection.
|
|
</summary>
|
|
<param name="part">The custom XML part to add.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes an item at the specified index.
|
|
</summary>
|
|
<param name="index">The zero based index.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.Clear">
|
|
<summary>
|
|
Removes all elements from the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.GetById(System.String)">
|
|
<summary>
|
|
Finds and returns a custom XML part by its identifier.
|
|
</summary>
|
|
<param name="id">Case-sensitive string that identifies the custom XML part.</param>
|
|
<returns>Returns <c>null</c> if a custom XML part with the specified identifier is not found.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Markup.CustomXmlPartCollection.Clone">
|
|
<summary>
|
|
Makes a deep copy of this collection and its items.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.CommentMark">
|
|
<summary>
|
|
Represents a container for text of a comment.
|
|
</summary>
|
|
<summary>
|
|
Class represents comment start marker
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.CommentMark.CommentId">
|
|
<summary>
|
|
Gets or sets the id of the comment this mark refers to.
|
|
</summary>
|
|
<value>The comment id.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.CommentMark.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.CommentMark.Type">
|
|
<summary>
|
|
Gets or sets the type of the CommentMark.
|
|
</summary>
|
|
<value>The type.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.CommentMark.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.CommentMark"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.CommentMark.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.Documents.CommentMarkType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.CommentMark"/> class.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
<param name="type">The comment mark type.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Rendering.PageLayoutHandler">
|
|
<summary>
|
|
Represents the method that will handle an event that with event data.
|
|
</summary>
|
|
<param name="sender">The source of the event</param>
|
|
<param name="args">args that contains event data</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Rendering.BookmarkLevelHandler">
|
|
<summary>
|
|
Represents the method that will handle an event that with event data.
|
|
</summary>
|
|
<param name="sender">The source of the event</param>
|
|
<param name="args">args that contains event data</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Rendering.BookmarkLevelEventArgs">
|
|
<summary>
|
|
BookmarkLevelEventArgs is the class containg event data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevelEventArgs.BookmarkStart">
|
|
<summary>
|
|
Represents the current bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevelEventArgs.BookmarkLevel">
|
|
<summary>
|
|
Represents the current bookmark level informations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Rendering.PageLayoutEventArgs">
|
|
<summary>
|
|
Spire.Doc.Documents.Rendering.DocumentLayouter.PageLayoutEventArgs is the class containg event data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.PageLayoutEventArgs.PageIndex">
|
|
<summary>
|
|
Represents the page number of documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.PageLayoutEventArgs.PageSetup">
|
|
<summary>
|
|
Represents the document page informations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Rendering.BookmarkLevel">
|
|
<summary>
|
|
Class BookmarkLevel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevel.ChildObjects">
|
|
<summary>
|
|
Gets the child objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevel.Color">
|
|
<summary>
|
|
Gets or Sets the text color of the bookmark when convert to PDF.
|
|
the default value is the "SaddleBrown" color(#FF8B4513).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevel.Name">
|
|
<summary>
|
|
Gets the name of the bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevel.Level">
|
|
<summary>
|
|
Gets or sets the level.
|
|
</summary>
|
|
<value>The level.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Rendering.BookmarkLevel.Style">
|
|
<summary>
|
|
Sets the text style of the bookmark when convert to PDF.
|
|
the default value is the Bold.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.MailMergeException">
|
|
<summary>
|
|
Summary description for MailMergeException.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.MailMergeException.#ctor">
|
|
<summary>
|
|
Default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.MailMergeException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.MailMergeException"/> class.
|
|
</summary>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.MailMergeException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.MailMergeException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.MailMergeException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.MailMergeException"/> class.
|
|
</summary>
|
|
<param name="message">The message.</param>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtBuildingBlockGallery">
|
|
<summary>
|
|
Specifies that the parent sdt shall be of a document part gallery type.
|
|
</summary>
|
|
<remarks>Read remarks about <see cref="T:Spire.Doc.Documents.SdtDocPartObj"/>.</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtBuildingBlockGallery.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag, which is set to Building Block Gallery.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtRepeatingSection.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag (SDT), which is a repeating section.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtCheckBox">
|
|
<summary>
|
|
Office2010 SDT checkbox control properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtCheckBox.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the SdtCheckBox class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.Type">
|
|
<summary>
|
|
Gets the type of the object, which is specified as a checkbox.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.Checked">
|
|
<summary>
|
|
Indicates if checkbox is in checked state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.CheckedStateFontName">
|
|
<summary>
|
|
Font name used for checked state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.CheckedStateCharacterCode">
|
|
<summary>
|
|
Character code used for checked state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.UnCheckedStateFontName">
|
|
<summary>
|
|
Font name used for unchecked state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCheckBox.UnCheckedStateCharacterCode">
|
|
<summary>
|
|
Character code used for unchecked state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtCheckBox.DefaultCheckedState">
|
|
<summary>
|
|
Represents the default checked state character, which is the Unicode character '☑' (U+2612).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtCheckBox.DefaultUncheckedState">
|
|
<summary>
|
|
Represents the default character used to denote an unchecked state, typically a square or open box symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtCheckBox.DefaultFontName">
|
|
<summary>
|
|
Represents the default font name used in the application, which is "MS Gothic".
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtCitation">
|
|
<summary>
|
|
Sdt of type citation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtCitation.Type">
|
|
<summary>
|
|
Gets the type of the object, which is set to <see cref="F:Spire.Doc.Documents.SdtType.Citation"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtComboBox">
|
|
<summary>
|
|
Sdt shall be a combo box when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtComboBox.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag (SDT), which is specified as a ComboBox.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SDTContent">
|
|
<summary>
|
|
specifies the last known contents of a structured document tag around one or more block-level structures
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTContent.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SDTInlineContent">
|
|
<summary>
|
|
This element specifies the last known contents of a structured document tag around one or more inline-level structures.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTInlineContent.ChildObjects">
|
|
<summary>
|
|
Gets the child objects.
|
|
</summary>
|
|
<value>The child objects.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTInlineContent.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the entity.
|
|
</summary>
|
|
<value>The type of the entity.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTInlineContent.OwnerParagraph">
|
|
<summary>
|
|
Gets the object owner paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTInlineContent.Text">
|
|
<summary>
|
|
Returns or sets STD text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTInlineContent.Item(System.Int32)">
|
|
<summary>
|
|
Gets paragraph item by index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtControlProperties">
|
|
<summary>
|
|
Base class for all Structured Document Tags control-specific properties.
|
|
Encapsulates all differences between Sdt controls, allowing to define additional
|
|
properties and methods in descendant classes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtControlProperties.Type">
|
|
<summary>
|
|
Gets the type of the structured data type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDataBinding">
|
|
<summary>
|
|
Specifies the information which shall be used to Eschertablish a mapping between the parent
|
|
structured document tag and an XML element stored within a Custom XML Data part in the current
|
|
WordprocessingML document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtDataBinding.Delete">
|
|
<summary>
|
|
Deletes mapping to XML data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDate">
|
|
<summary>
|
|
Specifies that the Sdt shall be a date picker when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDate.Type">
|
|
<summary>
|
|
Gets the type of the current instance, which is set to <see cref="F:Spire.Doc.Documents.SdtType.DatePicker"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDate.Lid">
|
|
<summary>
|
|
<para>This element specifies the language ID which shall be used for displaying a calendar for the current date picker
|
|
structured document tag, if a user interface is present for the sdt.</para>
|
|
<para>
|
|
If this element is omitted, then the language ID shall be the language ID of the run contents of the parent
|
|
structured document tag.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDate.DateFormat">
|
|
<summary>
|
|
The element specifies the display format which shall be used to format any date entered into the parent
|
|
structured document tag in full DateTime format [Example: Through a user interface (a date picker), or through
|
|
custom XML data associated with this structured document tag via the <see cref="T:Spire.Doc.Documents.SdtDataBinding"/> element end
|
|
example] before displaying it in the structured document tag's run content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDate.CalendarType">
|
|
<summary>
|
|
Date Picker Calendar Type, specifies the calendar which shall be displayed for the current date picker structured document
|
|
tag, if a user interface is present for the structured document tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDate.FullDate">
|
|
<summary>
|
|
Specifies the full date and time last entered into the parent structured document tag
|
|
using the standard XML Schema DateTime syntax.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDocPart">
|
|
<summary>
|
|
Common ancestor for <see cref="T:Spire.Doc.Documents.SdtBuildingBlockGallery"/> and <see cref="T:Spire.Doc.Documents.SdtDocPartObj"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDocPartObj">
|
|
<summary>
|
|
Specifies that the parent structured document tag shall be of a document part type.
|
|
</summary>
|
|
<remarks>
|
|
This element differs from the <see cref="T:Spire.Doc.Documents.SdtBuildingBlockGallery"/> element in that it can be used to semantically tag a set of
|
|
block-level objects in a WordprocessingML document without requiring the ability to specify a category and
|
|
gallery of objects which can be swapped with it via the user interface.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDocPartObj.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag (SDT), which is set to <see cref="F:Spire.Doc.Documents.SdtType.DocPartObj"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDropDownList">
|
|
<summary>
|
|
Specifies that the parent sdt shall be a drop-down list when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDropDownList.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag (SDT), which is a drop-down list.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtDropDownListBase">
|
|
<summary>
|
|
Common ancestor for <see cref="T:Spire.Doc.Documents.SdtDropDownList"/> and <see cref="T:Spire.Doc.Documents.SdtComboBox"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDropDownListBase.ListItems">
|
|
<summary>
|
|
Provides access to all list items <see cref="T:Spire.Doc.Documents.SdtListItem"/> of this <b>Sdt</b>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtDropDownListBase.LastValue">
|
|
<summary>
|
|
Gets or sets the last value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtListItem">
|
|
<summary>
|
|
This element specifies a single list item within a parent <see cref="F:Spire.Doc.Documents.SdtType.ComboBox"/> or <see cref="F:Spire.Doc.Documents.SdtType.DropDownList"/> structured document tag.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItem.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItem.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtListItem.DisplayText">
|
|
<summary>
|
|
Gets the text to display in the run content in place of the <see cref="P:Spire.Doc.Documents.SdtListItem.Value"/> attribute contents for this list item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtListItem.Value">
|
|
<summary>
|
|
Gets the value of this list item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtListItemCollection">
|
|
<summary>
|
|
Provides access to <see cref="T:Spire.Doc.Documents.SdtListItem"/> elements of a structured document tag.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItemCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an <ms>enumerator</ms><java>iterator</java> object that can be used to iterate over all items in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItemCollection.Add(Spire.Doc.Documents.SdtListItem)">
|
|
<summary>
|
|
Adds an item to this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItemCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes a list item at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the item to remove.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtListItemCollection.Clear">
|
|
<summary>
|
|
Clears all items from this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtListItemCollection.SelectedValue">
|
|
<summary>
|
|
Specifies currently selected value in this list.
|
|
Null value allowed, meaning that no currently selected entry is associated with this list item collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtListItemCollection.Item(System.Int32)">
|
|
<summary>
|
|
Returns a <see cref="T:Spire.Doc.Documents.SdtListItem"/> object given its zero-based index in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtListItemCollection.Count">
|
|
<summary>
|
|
Gets number of items in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtPicture">
|
|
<summary>
|
|
This element specifies that the parent sdt shall be a picture when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtPicture.ReplaceImage(System.Drawing.Image)">
|
|
<summary>
|
|
Replaces the image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtPicture.ReplaceImage(System.Byte[])">
|
|
<summary>
|
|
Replaces the image.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtPicture.Type">
|
|
<summary>
|
|
Gets the type of the object, which is set to Picture.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SDTProperties">
|
|
<summary>
|
|
This element specifies the set of properties that shall be applied to the nearest ancestor structured document tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.Id">
|
|
<summary>
|
|
Gets the id. specifes that the contents of this attribute contains a decimal number.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.Alias">
|
|
<summary>
|
|
Gets or sets the an alias.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.Tag">
|
|
<summary>
|
|
Gets or sets the a value specifies that its contents contain a string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.ControlProperties">
|
|
<summary>
|
|
Encapsulates all differences between different type of SDT-based content controls.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.SDTType">
|
|
<summary>
|
|
Gets or sets the Sdt type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.DataBinding">
|
|
<summary>
|
|
Gets the DataBinding object that represents the mapping of this
|
|
structured document tag to XML data in a custom XML part of
|
|
the current document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.LockSettings">
|
|
<summary>
|
|
Gets or sets a value that specifies locking behaviors
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.IsShowingPlaceHolder">
|
|
<summary>
|
|
Gets or sets a value indicating whether this instance is showing place holder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.IsTemporary">
|
|
<summary>
|
|
Gets or sets a value indicating whether remove SDT when contents are edited.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.Appearance">
|
|
<summary>
|
|
Gets or sets a value for the border appearance type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SDTProperties.Color">
|
|
<summary>
|
|
Gets or Sets the BaseColor of a structured document tag.
|
|
The Property is only available in Docx_2013 or above.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SDTProperties.#ctor(Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Initializes a new instance of the SDTProperties class with the specified owner.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtText">
|
|
<summary>
|
|
Represents plain/rich text SDT. See Iso29500, part 1, chapter 17.5.2.44
|
|
text (Plain Text Structured Document Tag)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.SdtText.#ctor(System.Boolean)">
|
|
<summary>
|
|
ctor.
|
|
</summary>
|
|
<param name="isRichText">if false, then this text control only allows plaintext, otherwise allows richtext.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtText.IsMultiline">
|
|
<summary>
|
|
Allow Soft Line Breaks. Specifies whether soft line breaks can be added to
|
|
the contents of this structured document tag when this document is modified.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.SdtText.Type">
|
|
<summary>
|
|
Gets the type of the structured document tag.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.StructureDocumentTag">
|
|
<summary>
|
|
This element specifies the presence of a structured document tag around one or more block-level structures
|
|
(paragraphs, tables, etc.). The two child elements of this element shall be used to specify the properties and
|
|
content of the current structured document tag via the sdtPr and sdtContent elements, respectively.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTag.SDTContent">
|
|
<summary>
|
|
Gets the a value specifies the last known contents of a structured document tag around one or more block-level structures.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTag.SDTProperties">
|
|
<summary>
|
|
Gets the structured document tag properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTag.BreakCharacterFormat">
|
|
<summary>
|
|
Gets character format for the break symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTag.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the entity.
|
|
</summary>
|
|
<value>The type of the entity.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTag.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.GetIndex(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Returns the zero-based index of the specified entity.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the Block-Level structured document tag class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.RemoveSelfOnly">
|
|
<summary>
|
|
Removes the SDT node itself, while preserving its content within the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.UpdateDataBinding">
|
|
<summary>
|
|
Updates stuctured documnet tag content with bound data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with newValue string, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString text to newValue.</param>
|
|
<param name="newValue">The newValue text .</param>
|
|
<param name="caseSensitive">if specifies case sensitive, set to <c>true</c> .</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with TextRangesHolder.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with TextRangesHolder.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="saveFormatting">if it specifies save source formatting, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with TextRangesHolder, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to check whole word, set to <c>true</c> .</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Replace(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with TextRangesHolder, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c> .</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c> .</param>
|
|
<param name="saveFormatting">if it specifies save source formatting, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTag.Find(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Returns first entry of given regex.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.StructureDocumentTagRow">
|
|
<summary>
|
|
This element specifies the presence of a structured document tag around a single table row. The two child
|
|
elements of this element shall be used to specify the properties and content of the current structured document
|
|
tag via the sdtPr and sdtContent elements, respectively.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.SDTProperties">
|
|
<summary>
|
|
Gets the structured document tag properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.BreakCharacterFormat">
|
|
<summary>
|
|
Gets character format for the break symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.ChildObjects">
|
|
<summary>
|
|
Gets the child object.
|
|
</summary>
|
|
<value>The child object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.Cells">
|
|
<summary>
|
|
Returns or sets cell collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagRow.RowFormat">
|
|
<summary>
|
|
Gets the row format for the current row.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagRow.#ctor(Spire.Doc.Table)">
|
|
<summary>
|
|
Initializes a new instance of the Block-Level structured document tag row class.
|
|
</summary>
|
|
<param name="ownerTable">The owner table.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagRow.UpdateDataBinding">
|
|
<summary>
|
|
Updates stuctured documnet tag content with bound data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagRow.RemoveSelfOnly">
|
|
<summary>
|
|
Removes the SDT node itself, while preserving its content within the document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.StructureDocumentTagCell">
|
|
<summary>
|
|
This element specifies the presence of a structured document tag around a single table cell. The two child
|
|
elements of this element shall be used to specify the properties and content of the current structured document
|
|
tag via the sdtPr and sdtContent elements, respectively.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagCell.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagCell.SDTProperties">
|
|
<summary>
|
|
Gets the structured document tag properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagCell.BreakCharacterFormat">
|
|
<summary>
|
|
Gets character format for the break symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagCell.#ctor(Spire.Doc.TableRow)">
|
|
<summary>
|
|
Initializes a new instance of the Block-Level structured document tag cell class.
|
|
</summary>
|
|
<param name="doc">The ownerRow.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagCell.UpdateDataBinding">
|
|
<summary>
|
|
Updates stuctured documnet tag content with bound data.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:Spire.Doc.Documents.StructureDocumentTagCell.RemoveSelfOnly" -->
|
|
<member name="T:Spire.Doc.Documents.StructureDocumentTagInline">
|
|
<summary>
|
|
This element specifies the presence of a structured document tag around one or more inline-level structures
|
|
(runs, DrawingML objects, fields, etc.) in the current paragraph. The two child elements of this element shall be
|
|
used to specify the properties and content of the current structured document tag via the sdtPr and sdtContent
|
|
elements, respectively.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagInline.SDTContent">
|
|
<summary>
|
|
Gets a valie specifies the last known contents of a structured document tag around one or more inline-level structures.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagInline.SDTProperties">
|
|
<summary>
|
|
Gets the structured document tag properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagInline.BreakCharacterFormat">
|
|
<summary>
|
|
Gets character format for the break symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagInline.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the entity.
|
|
</summary>
|
|
<value>The type of the entity.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.StructureDocumentTagInline.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagInline.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the Inline-Level structured document tag class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagInline.MakeChanges(System.Boolean)">
|
|
<summary>
|
|
Accepts or rejects changes tracked from the moment of last change acceptance.
|
|
</summary>
|
|
<param name="acceptChanges">if it accepts changes, set to <c>true</c>.</param>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:Spire.Doc.Documents.StructureDocumentTagInline.RemoveSelfOnly" -->
|
|
<member name="M:Spire.Doc.Documents.StructureDocumentTagInline.UpdateDataBinding">
|
|
<summary>
|
|
Updates stuctured documnet tag content with bound data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtType">
|
|
<summary>
|
|
Specifies the type of a structured document tag (SDT) Element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.None">
|
|
<summary>
|
|
No type is assigned to the SDT.
|
|
If no type element is specified, the SDT structured document tag should be a rich text box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.RichText">
|
|
<summary>
|
|
The SDT represents a rich text box when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Bibliography">
|
|
<summary>
|
|
The SDT represents a bibliography entry.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Citation">
|
|
<summary>
|
|
The SDT represents a citation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.ComboBox">
|
|
<summary>
|
|
The SDT represents a combo box when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.DropDownList">
|
|
<summary>
|
|
The SDT represents a drop down list when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Picture">
|
|
<summary>
|
|
The SDT represents a picture when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Text">
|
|
<summary>
|
|
The SDT represents a plain text box when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Equation">
|
|
<summary>
|
|
The SDT represents an equation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.DatePicker">
|
|
<summary>
|
|
The SDT represents a date picker when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.BuildingBlockGallery">
|
|
<summary>
|
|
The SDT represents a building block gallery type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.DocPartObj">
|
|
<summary>
|
|
The SDT represents a document part type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.Group">
|
|
<summary>
|
|
The SDT represents a restricted grouping when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.CheckBox">
|
|
<summary>
|
|
The SDT represents a checkbox when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.RepeatingSection">
|
|
<summary>
|
|
The SDT represents a repeating section when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtType.EntityPicker">
|
|
<summary>
|
|
The SDT represents a entity picker when displayed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.LockSettingsType">
|
|
<summary>
|
|
Specifies the possible set of locking behaviors which can be applied to the contents of the
|
|
Structured Document Tag when the contents of this documents are edited by an application (whether
|
|
through a user interface or directly).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.LockSettingsType.UnLocked">
|
|
<summary>
|
|
No locking.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.LockSettingsType.ContentLocked">
|
|
<summary>
|
|
Contents cannot be edited at runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.LockSettingsType.SDTContentLocked">
|
|
<summary>
|
|
Contents cannot be edited at runtime and SDT cannot be deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.LockSettingsType.SDTLocked">
|
|
<summary>
|
|
SDT cannot be deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.CalendarType">
|
|
<summary>
|
|
Specifies the possible types of calendars which can be used to specify <see cref="!:StructuredDocumentTag.CalendarType"/>
|
|
in an Office Open XML document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Default">
|
|
<summary>
|
|
Used as default value in Docx. Equals <see cref="F:Spire.Doc.Documents.CalendarType.Gregorian"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Gregorian">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
This calendar should be localized into the appropriate language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.GregorianArabic">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
The values for this calendar should be presented in Arabic.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.GregorianMiddleEastFrench">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
The values for this calendar should be presented in Middle East French.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.GregorianEnglish">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
The values for this calendar should be presented in English.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.GregorianTransliteratedEnglish">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
The values for this calendar should be the representation of the English strings in the corresponding Arabic characters
|
|
(the Arabic transliteration of the English for the Gregorian calendar).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.GregorianTransliteratedFrench">
|
|
<summary>
|
|
Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
|
|
The values for this calendar should be the representation of the French strings in the corresponding Arabic characters
|
|
(the Arabic transliteration of the French for the Gregorian calendar).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Hebrew">
|
|
<summary>
|
|
Specifies that the Hebrew lunar calendar, as described by the Gauss formula for Passover [CITATION]
|
|
and The Complete Restatement of Oral Law (Mishneh Torah),shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Hijri">
|
|
<summary>
|
|
Specifies that the Hijri lunar calendar, as described by the Kingdom of Saudi Arabia,
|
|
Ministry of Islamic Affairs, Endowments, Dawah and Guidance, shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Japan">
|
|
<summary>
|
|
Specifies that the Japanese Emperor Era calendar, as described by
|
|
Japanese Industrial Standard JIS X 0301, shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Korean">
|
|
<summary>
|
|
Specifies that the Korean Tangun Era calendar,
|
|
as described by Korean Law Enactment No. 4, shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.None">
|
|
<summary>
|
|
Specifies that no calendar should be used.
|
|
</summary>
|
|
<remarks>
|
|
Usually in AW, None is the first and default value for enums, but not in this case.
|
|
None is not default for OOXML, instead <see cref="F:Spire.Doc.Documents.CalendarType.Gregorian"/> is default and is first member of this enum.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Saka">
|
|
<summary>
|
|
Specifies that the Saka Era calendar, as described by the Calendar Reform Committee of India,
|
|
as part of the Indian Ephemeris and Nautical Almanac, shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Taiwan">
|
|
<summary>
|
|
Specifies that the Taiwanese calendar, as defined by the Chinese National Standard CNS 7648, shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CalendarType.Thai">
|
|
<summary>
|
|
Specifies that the Thai calendar, as defined by the Royal Decree of H.M. King Vajiravudh (Rama VI) in
|
|
Royal Gazette B. E. 2456 (1913 A.D.) and by the decree of Prime Minister Phibunsongkhram (1941 A.D.) to
|
|
start the year on the Gregorian January 1 and to map year zero to Gregorian year 543 B.C., shall be used.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SdtAppearance">
|
|
<summary>
|
|
Represents the appearance options for structured document tags (SDTs) in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtAppearance.BoundingBox">
|
|
<summary>
|
|
The appearance option of SDT is Bounding Box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtAppearance.Tags">
|
|
<summary>
|
|
The appearance option of SDT is tags.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtAppearance.Hidden">
|
|
<summary>
|
|
The appearance option of SDT is hidden, typically not visible or accessible to user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SdtAppearance.Default">
|
|
<summary>
|
|
Represents the default appearance of SDT(BoundingBox).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.CharacterStyle.Clone">
|
|
<summary>
|
|
Creates a copy of the current style object and returns it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasRunProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has run properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasParaProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has para properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasCellProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has cell properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasRowProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has row properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasTableProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has table properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ConditionalFormattingStyle.HasAnyProperties">
|
|
<summary>
|
|
Gets a value indicating whether this instance has any properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ConditionalFormattingStyle.GetHashCode">
|
|
<summary>
|
|
Calculates hash code for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListStyle">
|
|
<summary>
|
|
Represents a ListStyle.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListStyle.StyleType">
|
|
<summary>
|
|
Gets the type of the style.
|
|
</summary>
|
|
<value>The type of the style.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListStyle.ListRef">
|
|
<summary>
|
|
Gets the list reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListStyle.BaseStyle">
|
|
<summary>
|
|
Gets a base style of paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListStyle.Clone">
|
|
<summary>
|
|
Creates a clone of the current style.
|
|
</summary>
|
|
<returns>A new instance of the cloned style.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ParagraphStyle">
|
|
<summary>
|
|
Represents a style of paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ParagraphStyle.ParagraphFormat">
|
|
<summary>
|
|
Gets format for the paragraph style.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ParagraphStyle.BaseStyle">
|
|
<summary>
|
|
Gets a base style of paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ParagraphStyle.StyleType">
|
|
<summary>
|
|
Gets the type of the style.
|
|
</summary>
|
|
<value>The type of the style.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ParagraphStyle.ListFormat">
|
|
<summary>
|
|
Gets the list format for the paragraph style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ParagraphStyle.Frame">
|
|
<summary>
|
|
Gets the frame format for the paragraph style.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ParagraphStyle.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.ParagraphStyle"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ParagraphStyle.Clone">
|
|
<summary>
|
|
Clones the current ParagraphStyle object.
|
|
</summary>
|
|
<returns>A new ParagraphStyle object that is a copy of the current object.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.CharacterFormat">
|
|
<summary>
|
|
Gets the character format.
|
|
</summary>
|
|
<value>The character format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.Name">
|
|
<summary>
|
|
Gets or sets style name.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.StyleId">
|
|
<summary>
|
|
Gets or sets the style id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.StyleType">
|
|
<summary>
|
|
Gets the type of the style.
|
|
</summary>
|
|
<value>The type of the style.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.IsCustomStyle">
|
|
<summary>
|
|
Gets or sets a value indicating whether this instance is custom style.
|
|
</summary>
|
|
<value>if this instance is custom, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Style.IsHeading">
|
|
<summary>
|
|
Gets or sets a value indicating whether the style is heading style.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "P:Spire.Doc.Documents.Style.Istd" -->
|
|
<member name="M:Spire.Doc.Documents.Style.Clone">
|
|
<summary>
|
|
Creates a deep copy of the current style object.
|
|
</summary>
|
|
<returns>A new instance of the style object with the same properties as the current object.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListDefinitionReference">
|
|
<summary>
|
|
Represents a reference to a list definition within a document.
|
|
Implements maintains list level overrides.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListDefinitionReference.CompareTo(System.Object)">
|
|
<summary>
|
|
Compares the current instance with another object of the same type.
|
|
</summary>
|
|
<param name="obj">The object to compare with.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListDefinitionReference.CompareTo(Spire.Doc.Documents.ListDefinitionReference)">
|
|
<summary>
|
|
Compares the current instance with another ListDefinitionReference object based on their ListId values.
|
|
</summary>
|
|
<param name="obj">The other ListDefinitionReference object to compare with.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListDefinitionReference.HasSameTemplate(Spire.Doc.Documents.ListDefinitionReference)">
|
|
<summary>
|
|
Checks if the current list definition reference has the same template as another list definition reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.Levels">
|
|
<summary>
|
|
Gets a collection of levels from the terminal list definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.ListId">
|
|
<summary>
|
|
Gets the identifier for the list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.IsMultiLevel">
|
|
<summary>
|
|
Indicates whether the list has multiple levels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.IsListStyleDefinition">
|
|
<summary>
|
|
Gets a value indicating whether this is a list style definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.IsListStyleReference">
|
|
<summary>
|
|
Gets a value indicating whether the list style is a reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.Style">
|
|
<summary>
|
|
Gets the style associated with the list definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListDefinitionReference.Name">
|
|
<summary>
|
|
Gets the name from the list definition object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListTemplate">
|
|
<summary>
|
|
List template styles
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletDefault">
|
|
<summary>
|
|
Default bullet style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletDisk">
|
|
<summary>
|
|
Bullet disk style (alias for BulletDefault)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletCircle">
|
|
<summary>
|
|
Bullet circle style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletSquare">
|
|
<summary>
|
|
Bullet square style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletDiamonds">
|
|
<summary>
|
|
Bullet diamonds style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletArrowHead">
|
|
<summary>
|
|
Bullet arrow head style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.BulletTick">
|
|
<summary>
|
|
Bullet tick style (checkmark)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberDefault">
|
|
<summary>
|
|
Default number style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberArabicDot">
|
|
<summary>
|
|
Number Arabic dot style (alias for NumberDefault)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberArabicParenthesis">
|
|
<summary>
|
|
Number Arabic parenthesis style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberUppercaseRomanDot">
|
|
<summary>
|
|
Uppercase Roman numeral with dot style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberUppercaseLetterDot">
|
|
<summary>
|
|
Uppercase letter with dot style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberLowercaseLetterParenthesis">
|
|
<summary>
|
|
Lowercase letter with parenthesis style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberLowercaseLetterDot">
|
|
<summary>
|
|
Lowercase letter with dot style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.NumberLowercaseRomanDot">
|
|
<summary>
|
|
Lowercase Roman numeral with dot style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineNumbers">
|
|
<summary>
|
|
Outline numbers style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineLegal">
|
|
<summary>
|
|
Legal outline style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineBullets">
|
|
<summary>
|
|
Bullet outline style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineHeadingsArticleSection">
|
|
<summary>
|
|
Article/section heading outline style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineHeadingsLegal">
|
|
<summary>
|
|
Legal heading outline style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineHeadingsNumbers">
|
|
<summary>
|
|
Numbered heading outline style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListTemplate.OutlineHeadingsChapter">
|
|
<summary>
|
|
Chapter heading outline style
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListLevel">
|
|
<summary>
|
|
Summary description for ListLevel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.NumberAlignment">
|
|
<summary>
|
|
Get/set alignment (left, right, or centered) of the paragraph number.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.StartAt">
|
|
<summary>
|
|
Get/set start at value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.TabSpaceAfter">
|
|
<summary>
|
|
Get/set spacing after list level's number or bullet
|
|
( tab position if follow character is tab ).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.TextPosition">
|
|
<summary>
|
|
Returns or sets left listlevel indent
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.NumberPrefix">
|
|
<summary>
|
|
Gets / set prefix pattern for numbered level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.NumberSufix">
|
|
<summary>
|
|
Gets or sets suffix pattern for numbered level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.BulletCharacter">
|
|
<summary>
|
|
Get/set bullet pattern
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.PatternType">
|
|
<summary>
|
|
Gets or sets list numbering type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.NoRestartByHigher">
|
|
<summary>
|
|
True if the level's number sequence is not restarted by higher
|
|
(more significant) levels in the list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.CharacterFormat">
|
|
<summary>
|
|
Gets character format of list symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.ParagraphFormat">
|
|
<summary>
|
|
Gets paragraph format of list level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.FollowCharacter">
|
|
<summary>
|
|
Gets or Sets the type of character following the number text for the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.IsLegalStyleNumbering">
|
|
<summary>
|
|
Get/set ArabaicNumberFormat property
|
|
( true if the level turns all inherited numbers to arabic,
|
|
false if it preserves their number format code ).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.NumberPosition">
|
|
<summary>
|
|
Get/set number/bullet position for current listlevel.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.UsePrevLevelPattern">
|
|
<summary>
|
|
When true, number generated will include previous
|
|
levels (used for legal numbering).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.ListLevel.PictureBullet">
|
|
<summary>
|
|
Gets the picture bullet associated with the current object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.ListLevel"/> class with the specified document.
|
|
Creates and initializes the run and paragraph properties for the list level.
|
|
</summary>
|
|
<param name="doc">The document associated with the list level.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.GetListItemText(System.Int32,Spire.Doc.Documents.ListType)">
|
|
<summary>
|
|
Gets list symbol for specified item index
|
|
</summary>
|
|
<param name="listItemIndex"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.DeletePictureBullet">
|
|
<summary>
|
|
Deletes the picture bullet and resets the bullet properties to default values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.CreatePictureBullet">
|
|
<summary>
|
|
Creates a picture bullet in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevel.Equals(Spire.Doc.Documents.ListLevel)">
|
|
<summary>
|
|
Determines whether the specified ListLevel is considered equal to the current instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListLevelOverride">
|
|
<summary>
|
|
Represents a class for overriding the level format in a document serialization process.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.ListLevelOverride.GetHashCode">
|
|
<summary>
|
|
Gets the hash code for the current object.
|
|
</summary>
|
|
<returns>The computed hash code.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextBodyPart">
|
|
<summary>
|
|
Represents a part of text body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodyPart.BodyItems">
|
|
<summary>
|
|
Gets the body items.
|
|
</summary>
|
|
<value>The body items.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodyPart"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.#ctor(Spire.Doc.Documents.TextBodySelection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodyPart"/> class.
|
|
</summary>
|
|
<param name="textBodySelection">The text body selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.#ctor(Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodyPart"/> class.
|
|
</summary>
|
|
<param name="textSelection">The text selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodyPart"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.Clear">
|
|
<summary>
|
|
Clears this items in the body.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.Copy(Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Copies text from selection.
|
|
</summary>
|
|
<param name="textSel">The text selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.Copy(Spire.Doc.Documents.TextBodySelection)">
|
|
<summary>
|
|
Copies text from selection.
|
|
</summary>
|
|
<param name="textSel">The text selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.Copy(Spire.Doc.BodyRegion,System.Boolean)">
|
|
<summary>
|
|
Copies the specified body item.
|
|
</summary>
|
|
<param name="bodyItem">The body item.</param>
|
|
<param name="clone">if it is to clone, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.Copy(Spire.Doc.Fields.ParagraphBase,System.Boolean)">
|
|
<summary>
|
|
Copies the specified p item.
|
|
</summary>
|
|
<param name="pItem">The p item.</param>
|
|
<param name="clone">if it is to clone, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.PasteAfter(Spire.Doc.BodyRegion)">
|
|
<summary>
|
|
Pastes after specified item.
|
|
</summary>
|
|
<param name="bodyItem">The body item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.PasteAfter(Spire.Doc.Fields.ParagraphBase)">
|
|
<summary>
|
|
Pastes after specified paragraph item.
|
|
</summary>
|
|
<param name="paragraphItem">The paragraph item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.PasteAt(Spire.Doc.Interface.IBody,System.Int32)">
|
|
<summary>
|
|
Pastes at specified position.
|
|
</summary>
|
|
<param name="textBody">The text body.</param>
|
|
<param name="itemIndex">Index of the item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.PasteAt(Spire.Doc.Interface.IBody,System.Int32,System.Int32)">
|
|
<summary>
|
|
Pastes at specified position.
|
|
</summary>
|
|
<param name="textBody">The text body.</param>
|
|
<param name="itemIndex">Index of the item.</param>
|
|
<param name="pItemIndex">Index of the p item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodyPart.PasteAtEnd(Spire.Doc.Interface.IBody)">
|
|
<summary>
|
|
Pastes at end of textbody.
|
|
</summary>
|
|
<param name="textBody">The text body.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Margins">
|
|
<summary>
|
|
Class allows to store Page Margins (integer values).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Margins.All">
|
|
<summary>
|
|
Allow to Get or Set value of all Margins on one call
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Margins.Left">
|
|
<summary>
|
|
Gets or Sets the left margin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Margins.Right">
|
|
<summary>
|
|
Gets or Sets the right margin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Margins.Top">
|
|
<summary>
|
|
Gets or Sets the top margin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.Margins.Bottom">
|
|
<summary>
|
|
Gets or Sets the bottom margin
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Margins.#ctor">
|
|
<summary>
|
|
Default constructor. Set all margins to 0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.Margins.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Create margins with specified values
|
|
</summary>
|
|
<param name="left">Left margin</param>
|
|
<param name="top">Top margin</param>
|
|
<param name="right">Right margins</param>
|
|
<param name="bottom">Bottom margin</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PageSize">
|
|
<summary>
|
|
Represents information about page size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.A3">
|
|
<summary>
|
|
A3 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.A4">
|
|
<summary>
|
|
A4 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.A5">
|
|
<summary>
|
|
A5 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.A6">
|
|
<summary>
|
|
A6 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.B4">
|
|
<summary>
|
|
B4 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.B5">
|
|
<summary>
|
|
B5 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.B6">
|
|
<summary>
|
|
B5 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Letter">
|
|
<summary>
|
|
Letter format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.HalfLetter">
|
|
<summary>
|
|
HalfLetter format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Letter11x17">
|
|
<summary>
|
|
11x17 format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.EnvelopeDL">
|
|
<summary>
|
|
EnvelopeDL format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Quarto">
|
|
<summary>
|
|
Quarto format;.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Statement">
|
|
<summary>
|
|
Statement format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Ledger">
|
|
<summary>
|
|
Ledger format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Tabloid">
|
|
<summary>
|
|
Tabloid format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Note">
|
|
<summary>
|
|
Note format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Legal">
|
|
<summary>
|
|
Legal format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Flsa">
|
|
<summary>
|
|
Flsa format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageSize.Executive">
|
|
<summary>
|
|
Executive format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.XML.XDLSHolder">
|
|
<summary>
|
|
Summary description for DLSXmlHolder.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSHolder.ID">
|
|
<summary>
|
|
Gets or sets the ID.
|
|
</summary>
|
|
<value>The ID.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSHolder.Cleared">
|
|
<summary>
|
|
Gets or sets a value indicating whether this <see cref="T:Spire.Doc.Documents.XML.XDLSHolder"/> is cleared.
|
|
</summary>
|
|
<value>if it cleared, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSHolder.EnableID">
|
|
<summary>
|
|
Gets or sets a value indicating whether [enable ID].
|
|
</summary>
|
|
<value>If it is enable ID, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSHolder.SkipMe">
|
|
<summary>
|
|
Gets or sets a value indicating whether [skip me].
|
|
</summary>
|
|
<value>If it specifies to skip, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.XML.XDLSHolder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.Dispose">
|
|
<summary>
|
|
Releases all resources used by the current instance of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.AddElement(System.String,System.Object)">
|
|
<summary>
|
|
Adds the element.
|
|
</summary>
|
|
<param name="tagName">Name of the tag.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.AddRefElement(System.String,System.Object)">
|
|
<summary>
|
|
Adds the ref element.
|
|
</summary>
|
|
<param name="tagName">Name of the tag.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.WriteHolder(Spire.Doc.Interface.IXDLSContentWriter)">
|
|
<summary>
|
|
Writes the holder.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.ReadHolder(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Reads the holder.
|
|
</summary>
|
|
<param name="reader">The reader.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.AfterDeserialization(Spire.Doc.Interface.IDocumentSerializable)">
|
|
<summary>
|
|
After the deserialization.
|
|
</summary>
|
|
<param name="owner">The owner.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSHolder.BeforeSerialization">
|
|
<summary>
|
|
Before the serialization.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.XML.XDLSReader">
|
|
<summary>
|
|
Summary description for XDLSReader.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.#ctor(System.Xml.XmlReader)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.XML.XDLSReader"/> class.
|
|
</summary>
|
|
<param name="reader">The reader.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.Deserialize(Spire.Doc.Interface.IDocumentSerializable)">
|
|
<summary>
|
|
Deserializes the specified value.
|
|
</summary>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.HasAttribute(System.String)">
|
|
<summary>
|
|
Determines whether the current node has attribute with specified name.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns>
|
|
if has attribute with specified name, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadString(System.String)">
|
|
<summary>
|
|
Reads the string.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadInt(System.String)">
|
|
<summary>
|
|
Reads the int.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadShort(System.String)">
|
|
<summary>
|
|
Reads the short.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadDouble(System.String)">
|
|
<summary>
|
|
Reads the double.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadFloat(System.String)">
|
|
<summary>
|
|
Reads the float.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadBoolean(System.String)">
|
|
<summary>
|
|
Reads the boolean.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadByte(System.String)">
|
|
<summary>
|
|
Reads the byte.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadEnum(System.String,System.Type)">
|
|
<summary>
|
|
Reads the enum.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="enumType">Type of the enum.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadColor(System.String)">
|
|
<summary>
|
|
Reads color from XML.
|
|
</summary>
|
|
<param name="name">Name of attribute.</param>
|
|
<returns>Color structure.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadDateTime(System.String)">
|
|
<summary>
|
|
Reads datetime from XML.
|
|
</summary>
|
|
<param name="name">Name of attribute.</param>
|
|
<returns>datetime structure.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSReader.TagName">
|
|
<summary>
|
|
Gets the name of the tag.
|
|
</summary>
|
|
<value>The name of the tag.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSReader.NodeType">
|
|
<summary>
|
|
Gets the type of the node.
|
|
</summary>
|
|
<value>The type of the node.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.GetAttributeValue(System.String)">
|
|
<summary>
|
|
Gets the attribute value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ParseElementType(System.Type,System.Enum@)">
|
|
<summary>
|
|
Parses the type of the element.
|
|
</summary>
|
|
<param name="enumType">Type of the enum.</param>
|
|
<param name="elementType">Type of the element.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadChildElement(System.Object)">
|
|
<summary>
|
|
Reads the child element.
|
|
</summary>
|
|
<param name="value">The value.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadChildElement(System.Type)">
|
|
<summary>
|
|
Reads the child element.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadChildStringContent">
|
|
<summary>
|
|
Reads the content of the child string.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.XDLSReader.ReadChildBinaryElement">
|
|
<summary>
|
|
Reads binary value.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSReader.InnerReader">
|
|
<summary>
|
|
Gets the inner reader.
|
|
</summary>
|
|
<value>The inner reader.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.XDLSReader.AttributeReader">
|
|
<summary>
|
|
Gets the attribute reader.
|
|
</summary>
|
|
<value>The attribute reader.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.XML.DocumentSerializable">
|
|
<summary>
|
|
Represents a base class for document serializable objects, inheriting from OwnerHolder and implementing IDocumentSerializable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.DocumentSerializable.Spire#Doc#Interface#IDocumentSerializable#WriteXmlAttributes(Spire.Doc.Interface.IXDLSAttributeWriter)">
|
|
<summary>
|
|
Writes the XML attributes for the document using the specified attribute writer.
|
|
</summary>
|
|
<param name="writer">The attribute writer to use for writing the attributes.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.DocumentSerializable.Spire#Doc#Interface#IDocumentSerializable#WriteXmlContent(Spire.Doc.Interface.IXDLSContentWriter)">
|
|
<summary>
|
|
Writes the XML content for the document using the provided writer.
|
|
</summary>
|
|
<param name="writer">The writer to use for writing the XML content.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.DocumentSerializable.Spire#Doc#Interface#IDocumentSerializable#ReadXmlAttributes(Spire.Doc.Interface.IXDLSAttributeReader)">
|
|
<summary>
|
|
Reads XML attributes from the specified attribute reader.
|
|
</summary>
|
|
<param name="reader">The attribute reader to read from.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.DocumentSerializable.Spire#Doc#Interface#IDocumentSerializable#ReadXmlContent(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Reads the XML content from the specified reader.
|
|
</summary>
|
|
<param name="reader">The reader from which to read the XML content.</param>
|
|
<returns>True if the content was successfully read; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.DocumentSerializable.XDLSHolder">
|
|
<summary>
|
|
Gets the XDLSHolder for the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.XML.DocumentSerializable.Spire#Doc#Interface#IDocumentSerializable#RestoreReference(System.String,System.Int32)">
|
|
<summary>
|
|
Restores a reference to a previously serialized object.
|
|
</summary>
|
|
<param name="name">The name of the reference to restore.</param>
|
|
<param name="value">The value of the reference to restore.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.XML.DocumentSerializableCollection">
|
|
<summary>
|
|
Represents a collection of serializable documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.XML.DocumentSerializableCollection.TagItemName">
|
|
<summary>
|
|
Gets the name of the xml item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ShapeType">
|
|
<summary>
|
|
Specifies type of the Shape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeType.Group">
|
|
<summary>
|
|
the shape is a group shape
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeType.Image">
|
|
<summary>
|
|
The shape is an image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeType.TextBox">
|
|
<summary>
|
|
The shape is a textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeType.OleObject">
|
|
<summary>
|
|
The shape is an OLE object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeType.OleControl">
|
|
<summary>
|
|
The shape is an ActiveX control.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextWrappingStyle">
|
|
<summary>
|
|
Specify text wrapping style for object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.Inline">
|
|
<summary>
|
|
Inline text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.TopAndBottom">
|
|
<summary>
|
|
TopAndBottom text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.Square">
|
|
<summary>
|
|
Square text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.InFrontOfText">
|
|
<summary>
|
|
No text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.Tight">
|
|
<summary>
|
|
Tight text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.Through">
|
|
<summary>
|
|
Through text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.Behind">
|
|
<summary>
|
|
Behind text wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingStyle.None">
|
|
<summary>
|
|
None
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.DocumentObjectType">
|
|
<summary>
|
|
Specifies the type of a Document object type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Document">
|
|
<summary>
|
|
Represents a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Section">
|
|
<summary>
|
|
Section of document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Body">
|
|
<summary>
|
|
Body of document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.HeaderFooter">
|
|
<summary>
|
|
The header and footer of a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Paragraph">
|
|
<summary>
|
|
The text body items
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.StructureDocumentTag">
|
|
<summary>
|
|
Represents a structured document tag in a Word document, which is used to mark up content for custom XML data storage, form controls, or other structured data purposes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.StructureDocumentTagInline">
|
|
<summary>
|
|
Represents an inline-level structured document tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.StructureDocumentTagRow">
|
|
<summary>
|
|
Represents a row-level structured document tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.StructureDocumentTagCell">
|
|
<summary>
|
|
Represents a cell-level structured document tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SDTBlockContent">
|
|
<summary>
|
|
Block-Level Structure Document Tag Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SDTInlineContent">
|
|
<summary>
|
|
Inline-Level Structure Document Tag Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SDTRowContent">
|
|
<summary>
|
|
Row-Level Structure Document Tag Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SDTCellContent">
|
|
<summary>
|
|
Cell-Level Structure Document Tag Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Table">
|
|
<summary>
|
|
Represents a table structure that can store and manage data in rows and columns.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TableRow">
|
|
<summary>
|
|
Represents a row in a Table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TableCell">
|
|
<summary>
|
|
Represents a cell in a table row.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TextRange">
|
|
<summary>
|
|
The range of text
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Picture">
|
|
<summary>
|
|
Represents a picture or image,
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.FieldStart">
|
|
<summary>
|
|
Represents the starting position of a field in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Field">
|
|
<summary>
|
|
Represents a field in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.FieldMark">
|
|
<summary>
|
|
Represents a marker or indicator used to highlight or denote specific fields within a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.FieldSeparator">
|
|
<summary>
|
|
Represents the separator of a composite field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.FieldEnd">
|
|
<summary>
|
|
Represents the end position of a field in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.MergeField">
|
|
<summary>
|
|
Represents a merge field in a document, which is a placeholder for data that will be inserted during a mail merge operation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SeqField">
|
|
<summary>
|
|
Represents a field within a sequence, often used for unmbering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.EmbededField">
|
|
<summary>
|
|
Represents an embedded field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.ControlField">
|
|
<summary>
|
|
Represents a control field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TextFormField">
|
|
<summary>
|
|
Represents a text input form field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.DropDownFormField">
|
|
<summary>
|
|
Represents a form field that allows users to select a value from a dropdown list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.CheckBox">
|
|
<summary>
|
|
Represents a checkbox from field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.BookmarkStart">
|
|
<summary>
|
|
Represents the starting of a bookmark within a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.BookmarkEnd">
|
|
<summary>
|
|
Represents the end of a bookmark in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.MoveFromRangeStart">
|
|
<summary>
|
|
The start of a region whose move source contents are part of a single named move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.MoveFromRangeEnd">
|
|
<summary>
|
|
The end of a region whose move source contents are part of a single named move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.MoveToRangeStart">
|
|
<summary>
|
|
The start of a region whose move destination contents are part of a single named move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.MoveToRangeEnd">
|
|
<summary>
|
|
The end of a region whose move destination contents are part of a single named move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.PermissionStart">
|
|
<summary>
|
|
Represents the start of a permission block
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.PermissionEnd">
|
|
<summary>
|
|
Represents the end of a permission block
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Shape">
|
|
<summary>
|
|
Represents shape object
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.ShapeGroup">
|
|
<summary>
|
|
Represents a group of shapes that can be manipulated together as a single unit.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.ShapeLine">
|
|
<summary>
|
|
Represents a line shape
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.ShapePath">
|
|
<summary>
|
|
Represents a path that can be used to define the outline or boundary of a shape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.ShapeRect">
|
|
<summary>
|
|
Represents a rectangle shape
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Comment">
|
|
<summary>
|
|
Represents a comment annotation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Footnote">
|
|
<summary>
|
|
Represents a footnote in a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TextBox">
|
|
<summary>
|
|
Represents a text box
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Break">
|
|
<summary>
|
|
Represents a break, such as page berak or column break
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Symbol">
|
|
<summary>
|
|
Represents a special symbol character
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.TOC">
|
|
<summary>
|
|
Table of Contents
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.XmlParaItem">
|
|
<summary>
|
|
Represents an XML paragraph item
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Undefined">
|
|
<summary>
|
|
Represents an undefined or unspecified object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.CommentMark">
|
|
<summary>
|
|
Represents a comment mark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.OleObject">
|
|
<summary>
|
|
Represents an OLE (Object Linking and Embedding) object
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.CustomXml">
|
|
<summary>
|
|
Represents a custom XML data in a document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SmartTag">
|
|
<summary>
|
|
Represents a smart tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.OfficeMath">
|
|
<summary>
|
|
Represents a mathematical object in a document, such as an equation or formula.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.System">
|
|
<summary>
|
|
Reserved for internal use by Spire.Words.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Ruby">
|
|
<summary>
|
|
Phonetic Guide
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SubDocument">
|
|
<summary>
|
|
Represents sub document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.SpecialChar">
|
|
<summary>
|
|
Represents a special character
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.GlossaryDocument">
|
|
<summary>
|
|
Represents glossary document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.BuildingBlock">
|
|
<summary>
|
|
Represents a building block
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.FormField">
|
|
<summary>
|
|
Represents a form field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentObjectType.Any">
|
|
<summary>
|
|
Indicates all Element types. Allows to select all children.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.HeaderFooterType">
|
|
<summary>
|
|
Specifies type of the Header/Footer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.HeaderEven">
|
|
<summary>
|
|
Header for even numbered pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.HeaderOdd">
|
|
<summary>
|
|
Header for odd numbered pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.FooterEven">
|
|
<summary>
|
|
Footer for even numbered pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.FooterOdd">
|
|
<summary>
|
|
Footer for odd numbered pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.HeaderFirstPage">
|
|
<summary>
|
|
Header for the first page of the section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HeaderFooterType.FooterFirstPage">
|
|
<summary>
|
|
Footer for the first page of the section.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.StyleType">
|
|
<summary>
|
|
Specifies type of the Style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.StyleType.ParagraphStyle">
|
|
<summary>
|
|
The style is a paragraph style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.StyleType.CharacterStyle">
|
|
<summary>
|
|
The style is a character style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.StyleType.TableStyle">
|
|
<summary>
|
|
The style is a table style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.StyleType.ListStyle">
|
|
<summary>
|
|
The style is a list style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.StyleType.OtherStyle">
|
|
<summary>
|
|
The style is other kind of style.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ParagraphItemType">
|
|
<summary>
|
|
Specifies type of the ParagraphBase.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.TextRange">
|
|
<summary>
|
|
ParagraphBase is a text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Picture">
|
|
<summary>
|
|
ParagraphBase is a picture.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Field">
|
|
<summary>
|
|
ParagraphBase is a field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.FieldMark">
|
|
<summary>
|
|
Paragraph item is field mark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.MergeField">
|
|
<summary>
|
|
ParagraphBase is a merge field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.FormField">
|
|
<summary>
|
|
ParagraphBase is a a form field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.CheckBox">
|
|
<summary>
|
|
ParagraphBase is a a checkbox
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.TextFormField">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.DropDownFormField">
|
|
<summary>
|
|
ParagraphBase is a drop-down form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.SeqField">
|
|
<summary>
|
|
ParagraphBase is a sequence field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.EmbedField">
|
|
<summary>
|
|
ParagraphBase is a embedded field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.ControlField">
|
|
<summary>
|
|
Paragraph item is form control field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.BookmarkStart">
|
|
<summary>
|
|
ParagraphBase is a start of bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.BookmarkEnd">
|
|
<summary>
|
|
ParagraphBase is a end of bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.PermissionStart">
|
|
<summary>
|
|
ParagraphBase is a start of Permission
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.PermissionEnd">
|
|
<summary>
|
|
ParagraphBase is a end of Permission.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.ShapeObject">
|
|
<summary>
|
|
ParagraphBase is a shape object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.ShapeGroup">
|
|
<summary>
|
|
ParagraphBase is a group of shapes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Comment">
|
|
<summary>
|
|
ParagraphBase is a comment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.CommentMark">
|
|
<summary>
|
|
Paragraph item is comment mark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Footnote">
|
|
<summary>
|
|
ParagraphBase is a footnote.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.TextBox">
|
|
<summary>
|
|
ParagraphBase is a textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Break">
|
|
<summary>
|
|
PragraphItem is a break.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.Symbol">
|
|
<summary>
|
|
ParagraphBase is a symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.TOC">
|
|
<summary>
|
|
ParagraphBase is a Table of Contents
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ParagraphItemType.OleObject">
|
|
<summary>
|
|
ParagraphBase is an OLE object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PageOrientation">
|
|
<summary>
|
|
Specifies orientation of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageOrientation.Portrait">
|
|
<summary>
|
|
Portrait page orientation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageOrientation.Landscape">
|
|
<summary>
|
|
Landscape page orientation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PageAlignment">
|
|
<summary>
|
|
Specifies alignment of the text on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageAlignment.Top">
|
|
<summary>
|
|
Text is aligned at the top of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageAlignment.Middle">
|
|
<summary>
|
|
Text is aligned at the middle of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageAlignment.Justified">
|
|
<summary>
|
|
Text is spanned to fill the page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageAlignment.Bottom">
|
|
<summary>
|
|
Text is aligned at the bottom of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.VerticalAlignment">
|
|
<summary>
|
|
Specifies type of the vertical alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.VerticalAlignment.Top">
|
|
<summary>
|
|
Specifies top alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.VerticalAlignment.Middle">
|
|
<summary>
|
|
Specifies middle alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.VerticalAlignment.Bottom">
|
|
<summary>
|
|
Specifies bottom alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.HorizontalAlignment">
|
|
<summary>
|
|
Specifies type of the horizontal alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.Left">
|
|
<summary>
|
|
Specifies alignment to the left.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.Center">
|
|
<summary>
|
|
Specifies alignment to the center.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.Right">
|
|
<summary>
|
|
Specifies alignment to the right.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.Justify">
|
|
<summary>
|
|
Specifies alignment to both left and right.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.Distribute">
|
|
<summary>
|
|
Specifies that the text shall be justified between both
|
|
of the text margins in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.ThaiDistribute">
|
|
<summary>
|
|
Specifies that the text shall be justified with an optimization for Thai.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.HightKashida">
|
|
<summary>
|
|
Specifies that the kashida length for text in the current paragraph
|
|
shall be extended to its wides possible length.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.LowKashida">
|
|
<summary>
|
|
Specifies that the kashida length for text in the current paragraph
|
|
shall be exended to a slightly longer length.
|
|
This setting shall also be applied to Arabic text when the both setting is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HorizontalAlignment.MediumKashida">
|
|
<summary>
|
|
Specifies that the kashida length for text in the current paragraph
|
|
shall be extended to a medium length determined by the consumer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.RowAlignment">
|
|
<summary>
|
|
Specifies type of the horizontal alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RowAlignment.Left">
|
|
<summary>
|
|
Specifies alignment to the left.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RowAlignment.Center">
|
|
<summary>
|
|
Specifies alignment to the center.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RowAlignment.Right">
|
|
<summary>
|
|
Specifies alignment to the right.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.UnderlineStyle">
|
|
<summary>
|
|
Specifies style of the underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.None">
|
|
<summary>
|
|
No underlining.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Single">
|
|
<summary>
|
|
Normal single underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Words">
|
|
<summary>
|
|
Underline words only.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Double">
|
|
<summary>
|
|
Double underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Dotted">
|
|
<summary>
|
|
Dotted underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Thick">
|
|
<summary>
|
|
Heavy underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Dash">
|
|
<summary>
|
|
Dashed underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DotDash">
|
|
<summary>
|
|
Dot-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DotDotDash">
|
|
<summary>
|
|
Dot-dot-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.Wavy">
|
|
<summary>
|
|
Wavy underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DottedHeavy">
|
|
<summary>
|
|
Heavy dotted underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DashHeavy">
|
|
<summary>
|
|
Heavy dashed underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DotDashHeavy">
|
|
<summary>
|
|
Heavy dot-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DotDotDashHeavy">
|
|
<summary>
|
|
Heavy dot-dot-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.WavyHeavy">
|
|
<summary>
|
|
Heavy wavy underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DashLong">
|
|
<summary>
|
|
Long-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.WavyDouble">
|
|
<summary>
|
|
Wavy double underline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.UnderlineStyle.DashLongHeavy">
|
|
<summary>
|
|
Heavy long-dash underline.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SubSuperScript">
|
|
<summary>
|
|
Specifies type of the SubSuperScript.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SubSuperScript.None">
|
|
<summary>
|
|
No sub- or superscript.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SubSuperScript.SuperScript">
|
|
<summary>
|
|
Specified superscript format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SubSuperScript.SubScript">
|
|
<summary>
|
|
Specified subscript format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SubSuperScript.BaseLine">
|
|
<summary>
|
|
Specified baseline format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.Emphasis">
|
|
<summary>
|
|
Specifies the emphasis mark type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.None">
|
|
<summary>
|
|
No Emphasis Mark
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.Dot">
|
|
<summary>
|
|
Dot Emphasis Mark Above Characters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.CommaAbove">
|
|
<summary>
|
|
Comma Emphasis Mark Above Characters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.CircleAbove">
|
|
<summary>
|
|
Circle Emphasis Mark Above Characters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.DotBelow">
|
|
<summary>
|
|
Dot Emphasis Mark Below Characters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.Emphasis.Default">
|
|
<summary>
|
|
Represents the default emphasis mark type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BorderStyle">
|
|
<summary>
|
|
Specifies style of the border line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.None">
|
|
<summary>
|
|
No border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Single">
|
|
<summary>
|
|
A single line border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Thick">
|
|
<summary>
|
|
A thick line border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Double">
|
|
<summary>
|
|
A double line border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Hairline">
|
|
<summary>
|
|
A hairline border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Dot">
|
|
<summary>
|
|
A dotted border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DashLargeGap">
|
|
<summary>
|
|
A dashed border with large gaps is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DotDash">
|
|
<summary>
|
|
A dot-dash border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DotDotDash">
|
|
<summary>
|
|
A dot-dot-dash border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Triple">
|
|
<summary>
|
|
A triple line border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickSmallGap">
|
|
<summary>
|
|
A thin-thick line border with a small gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThickThinSmallGap">
|
|
<summary>
|
|
A thick-thin line border with a small gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThinSmallGap">
|
|
<summary>
|
|
A thick-thin line border with a small gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickThinSmallGap">
|
|
<summary>
|
|
A thin-thin-thick line border with a small gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickMediumGap">
|
|
<summary>
|
|
A thin-thick line border with a medium gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThickThinMediumGap">
|
|
<summary>
|
|
A thick-thin line border with a medium gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickThinMediumGap">
|
|
<summary>
|
|
A thin-thick-thin line border with a medium gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThickThickThinMediumGap">
|
|
<summary>
|
|
A thick-thick-thin line border with a medium gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickLargeGap">
|
|
<summary>
|
|
A thin-thick line border with a large gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThickThinLargeGap">
|
|
<summary>
|
|
A thick-thin line border with a large gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.ThinThickThinLargeGap">
|
|
<summary>
|
|
A thin-thick-thin line border with a large gap is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Wave">
|
|
<summary>
|
|
A wavy border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DoubleWave">
|
|
<summary>
|
|
A double wave border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DashSmallGap">
|
|
<summary>
|
|
A dashed border with small gaps is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.DashDotStroker">
|
|
<summary>
|
|
A dashed border with dot stroker effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Emboss3D">
|
|
<summary>
|
|
A border with emboss 3D effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Engrave3D">
|
|
<summary>
|
|
A border with engrave 3D effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Outset">
|
|
<summary>
|
|
A border with outset effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.Inset">
|
|
<summary>
|
|
A border with inset effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BorderStyle.TwistedLines1">
|
|
<summary>
|
|
A twisted lines 1 border effect is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.SectionBreakType">
|
|
<summary>
|
|
Specifies type of the section break code.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SectionBreakType.NoBreak">
|
|
<summary>
|
|
The section starts on the same page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SectionBreakType.NewColumn">
|
|
<summary>
|
|
The section starts from a new column.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SectionBreakType.NewPage">
|
|
<summary>
|
|
The section starts from a new page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SectionBreakType.EvenPage">
|
|
<summary>
|
|
The section starts on a new even page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.SectionBreakType.Oddpage">
|
|
<summary>
|
|
The section starts on a new odd page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.HyperlinkType">
|
|
<summary>
|
|
Specifies type of the link.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HyperlinkType.None">
|
|
<summary>
|
|
No links.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HyperlinkType.FileLink">
|
|
<summary>
|
|
Links to another file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HyperlinkType.WebLink">
|
|
<summary>
|
|
Links to a web page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HyperlinkType.EMailLink">
|
|
<summary>
|
|
Link to e-mail.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.HyperlinkType.Bookmark">
|
|
<summary>
|
|
Bookmark link.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListType">
|
|
<summary>
|
|
Specifies type of the list format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListType.Numbered">
|
|
<summary>
|
|
Specifies numbered list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListType.Bulleted">
|
|
<summary>
|
|
Specifies bulleted list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListType.NoList">
|
|
<summary>
|
|
No numbering.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListPatternType">
|
|
<summary>
|
|
Specifies type of the list numbering format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Arabic">
|
|
<summary>
|
|
Specifies default numbering format.
|
|
Arabic numbering (1, 2, 3, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.UpRoman">
|
|
<summary>
|
|
Specifies UppRoman numbering format.
|
|
Upper case Roman (I, II, III, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.LowRoman">
|
|
<summary>
|
|
Specifies LowRoman numbering format.
|
|
Lower case Roman (i, ii, iii, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.UpLetter">
|
|
<summary>
|
|
Specifies UpLetter numbering format.
|
|
Upper case Letter (A, B, C, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.LowLetter">
|
|
<summary>
|
|
Specifies LowLetter numbering format.
|
|
Lower case letter (a, b, c, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Ordinal">
|
|
<summary>
|
|
Specifies Ordinal numbering format.
|
|
Ordinal (1st, 2nd, 3rd, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.CardinalText">
|
|
<summary>
|
|
Specifies Cardinal Text numbering format.
|
|
Numbered (One, Two, Three, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.OrdinalText">
|
|
<summary>
|
|
Specifies Ordinal Text numbering format.
|
|
Ordinal (text) (First, Second, Third, ...)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Hex">
|
|
<summary>
|
|
Specifies that the sequence shall consist of hexadecimal numbering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Chicago">
|
|
<summary>
|
|
Chicago manual of style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographDigital">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical ideographs, using the appropriate character,
|
|
as described below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.JapaneseCounting">
|
|
<summary>
|
|
Japanese Counting System.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Japanese counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Aiueo">
|
|
<summary>
|
|
<para>Specifies that the sequence shall consist of one or more occurrences of a single </para>
|
|
<para>half-width katakana character from the set listed below, in the traditional</para>
|
|
<para>a-i-u-e-o order.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Iroha">
|
|
<summary>
|
|
Specifies that the sequence shall consist of the iroha.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalFullWidth">
|
|
<summary>
|
|
Specifies that the sequence shall consist of full-width Arabic numbering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalHalfWidth">
|
|
<summary>
|
|
Specifies that the sequence shall consist of half-width Arabic numbering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.JapaneseLegal">
|
|
<summary>
|
|
Japanese Legal Numbering.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Japanese legal counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.JapaneseDigitalTenThousand">
|
|
<summary>
|
|
Japanese Digital Ten Thousand Counting System.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Japanese digital the thousand counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalEnclosedCircle">
|
|
<summary>
|
|
Decimal Numbers Enclosed in a Circle.
|
|
Specifies that the sequence shall consist of sequential numbering enclosed
|
|
in a circle,using the enclosed character.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.AiueoFullWidth">
|
|
<summary>
|
|
Specifies that the sequence shal consist of one or more occurrences of a single
|
|
full-width katakana character,in the traditonal a-i-u-e-o order.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IrohaFullWidth">
|
|
<summary>
|
|
Specifies that the sequence shall consist of the full-width forms of the iroha.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.LeadingZero">
|
|
<summary>
|
|
Specifies LeadingZero numbering format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Bullet">
|
|
<summary>
|
|
Specifies Bullet numbering format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Ganada">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of a single sequential number from
|
|
the Korean Ganada format, from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Chosung">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of a single sequential number from
|
|
the Korean Chosung format, from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalEnclosedFullstop">
|
|
<summary>
|
|
Decimal numbers followed by a period.
|
|
Specifies that the sequence shall consist of decimal numbering followed
|
|
by a period,using the appropriate character,as described below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalEnclosedParen">
|
|
<summary>
|
|
Decimal numbers enclosed in parenthesis.
|
|
Specifies that the sequence shall consist of decimal numbering enclosed in parentheses.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.DecimalEnclosedCircleChinese">
|
|
<summary>
|
|
Identical to DecimalEnclosedCircle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographEnclosedCircle">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographTraditional">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical traditonal ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographZodiac">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical zodiac ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographZodiacTraditional">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential traditional zodiac ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.TaiwaneseCounting">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.IdeographLegalTraditional">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical traditional legal ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.TaiwaneseCountingThousand">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting thousand system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.TaiwaneseDigital">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numbers from the Taiwanese digital counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ChineseCounting">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single ascending number from the chinese counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ChineseLegalSimplified">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single sequential number from the Chineses simplified legal format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ChineseCountingThousand">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single sequential number from the Chineses counting thousand system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.KoreanDigital">
|
|
<summary>
|
|
Korean Digital Counting System.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Korean digital counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.KoreanCounting">
|
|
<summary>
|
|
Korean Counting System.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Korean counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.KoreanLegal">
|
|
<summary>
|
|
Korean Legal numbering.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Korean legal numbering system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.KoreanDigital2">
|
|
<summary>
|
|
Korean Digital Counting System Alternate.
|
|
Specifies that the sequence shall consist of sequential numbers from
|
|
the Korean digital counting system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Hebrew1">
|
|
<summary>
|
|
Specifies that the sequence shall consist of Hebrew letters from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ArabicAlpha">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single character int the Arabic alphabet from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.Hebrew2">
|
|
<summary>
|
|
Specifies that the sequence shall consist of the Hebrew alphabet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ArabicAbjad">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single ascending Abjad numerall from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.HindiVowels">
|
|
<summary>
|
|
Hindi vowels
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.HindiConsonants">
|
|
<summary>
|
|
Hindi consonants
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.HindiNumbers">
|
|
<summary>
|
|
Hindi numbers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.HindiCounting">
|
|
<summary>
|
|
Hindi descriptive (cardinals)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ThaiLetters">
|
|
<summary>
|
|
Thai letters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ThaiNumbers">
|
|
<summary>
|
|
Thai numbers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.ThaiCounting">
|
|
<summary>
|
|
Thai descriptive (cardinals)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.VietnameseCounting">
|
|
<summary>
|
|
Vietnamese descriptive (cardinals)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.NumberInDash">
|
|
<summary>
|
|
Page number format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.LowercaseRussian">
|
|
<summary>
|
|
Lowercase Russian alphabet
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.UppercaseRussian">
|
|
<summary>
|
|
Uppercase Russian alphabet
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.None">
|
|
<summary>
|
|
Specifies None numbering format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListPatternType.CustomType">
|
|
<summary>
|
|
Specifies custom format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.CellMerge">
|
|
<summary>
|
|
Specifies the way of cell merging.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CellMerge.None">
|
|
<summary>
|
|
No merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CellMerge.Start">
|
|
<summary>
|
|
Merge starts from this cell.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CellMerge.Continue">
|
|
<summary>
|
|
Merge is continued.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.HorizontalOrigin">
|
|
<summary>
|
|
Specify object's horizontal origin
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.VerticalOrigin">
|
|
<summary>
|
|
Specify vertical origin of the object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ShapeLineStyle">
|
|
<summary>
|
|
Represents different line styles for shapes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.Single">
|
|
<summary>
|
|
Single line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.Double">
|
|
<summary>
|
|
Double lines of equal width.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.ThickThin">
|
|
<summary>
|
|
Double lines, one thick, one thin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.ThinThick">
|
|
<summary>
|
|
Double lines, one thin, one thick.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.Triple">
|
|
<summary>
|
|
Three lines, thin, thick, thin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ShapeLineStyle.Default">
|
|
<summary>
|
|
Default value is <see cref="F:Spire.Doc.Documents.ShapeLineStyle.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextBoxLineStyle">
|
|
<summary>
|
|
Specify object's line style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextBoxLineStyle.Simple">
|
|
<summary>
|
|
Single line (of width lineWidth)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextBoxLineStyle.Double">
|
|
<summary>
|
|
Double lines of equal width
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextBoxLineStyle.ThickThin">
|
|
<summary>
|
|
Double lines, one thick, one thin
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextBoxLineStyle.ThinThick">
|
|
<summary>
|
|
Double lines, reverse order
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextBoxLineStyle.Triple">
|
|
<summary>
|
|
Three lines, thin, thick, thin
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextWrappingType">
|
|
<summary>
|
|
Specify text wrapping type for textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingType.Both">
|
|
<summary>
|
|
Wrap text both sides
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingType.Left">
|
|
<summary>
|
|
Wrap text left side
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingType.Right">
|
|
<summary>
|
|
Wrap text right side
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingType.Largest">
|
|
<summary>
|
|
Wrap text largest
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextWrappingType.Default">
|
|
<summary>
|
|
The default.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TabJustification">
|
|
<summary>
|
|
Specifies the tab justification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Left">
|
|
<summary>
|
|
Left tab.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Centered">
|
|
<summary>
|
|
Centered tab.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Right">
|
|
<summary>
|
|
Right tab.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Decimal">
|
|
<summary>
|
|
Decimal tab.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Bar">
|
|
<summary>
|
|
Bar.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.List">
|
|
<summary>
|
|
List tab justification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabJustification.Clear">
|
|
<summary>
|
|
Clears any tab stop in this position.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TabLeader">
|
|
<summary>
|
|
Specifies Tab leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.NoLeader">
|
|
<summary>
|
|
No leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.Dotted">
|
|
<summary>
|
|
Dotted leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.Hyphenated">
|
|
<summary>
|
|
Hyphenated leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.Single">
|
|
<summary>
|
|
Single line leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.Heavy">
|
|
<summary>
|
|
Heavy line leader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TabLeader.MiddleDot">
|
|
<summary>
|
|
The leader line is made up from middle-dots.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TableRowHeightType">
|
|
<summary>
|
|
Specifies the table row height type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TableRowHeightType.AtLeast">
|
|
<summary>
|
|
"At least" table row height type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TableRowHeightType.Exactly">
|
|
<summary>
|
|
" Exactly" table row height type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TableRowHeightType.Auto">
|
|
<summary>
|
|
The height will grow automatically to accommodate all text inside an object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ListNumberAlignment">
|
|
<summary>
|
|
Number alignments
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListNumberAlignment.Left">
|
|
<summary>
|
|
Number aligned left
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListNumberAlignment.Center">
|
|
<summary>
|
|
Number is centered
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ListNumberAlignment.Right">
|
|
<summary>
|
|
Number aligned right
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FollowCharacterType">
|
|
<summary>
|
|
The type of character following the number text for the paragraph
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FollowCharacterType.Tab">
|
|
<summary>
|
|
List levels number or bullet is followed by tab
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FollowCharacterType.Space">
|
|
<summary>
|
|
List levels number or bullet is followed by space
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FollowCharacterType.Nothing">
|
|
<summary>
|
|
Follow character isn't used
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PictureColor">
|
|
<summary>
|
|
Picture color types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PictureColor.Automatic">
|
|
<summary>
|
|
Picture automatic color.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PictureColor.Grayscale">
|
|
<summary>
|
|
Picture grayscale color.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PictureColor.BlackAndWhite">
|
|
<summary>
|
|
Picture black and white color.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PictureColor.Washout">
|
|
<summary>
|
|
Picture washout color.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BreakType">
|
|
<summary>
|
|
Document's break type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BreakType.PageBreak">
|
|
<summary>
|
|
Page break type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BreakType.ColumnBreak">
|
|
<summary>
|
|
Column break type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BreakType.LineBreak">
|
|
<summary>
|
|
Line break type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.WatermarkType">
|
|
<summary>
|
|
Specifies the watermark type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.WatermarkType.NoWatermark">
|
|
<summary>
|
|
No watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.WatermarkType.PictureWatermark">
|
|
<summary>
|
|
Picture watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.WatermarkType.TextWatermark">
|
|
<summary>
|
|
Text watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.WatermarkLayout">
|
|
<summary>
|
|
Specifies WatermarkLayout.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.WatermarkLayout.Diagonal">
|
|
<summary>
|
|
Diagonal watermark layout.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.WatermarkLayout.Horizontal">
|
|
<summary>
|
|
Horizontal watermark layout.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BackgroundType">
|
|
<summary>
|
|
Specifies BackgroundType
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BackgroundType.NoBackground">
|
|
<summary>
|
|
No background fill effect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BackgroundType.Gradient">
|
|
<summary>
|
|
Gradient fill effect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BackgroundType.Picture">
|
|
<summary>
|
|
Picture fill effect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BackgroundType.Texture">
|
|
<summary>
|
|
Texture fill effect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.BackgroundType.Color">
|
|
<summary>
|
|
Color fill effect.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.GradientShadingStyle">
|
|
<summary>
|
|
Shading styles for Gradient background effect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.Horizontal">
|
|
<summary>
|
|
Horizontal shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.Vertical">
|
|
<summary>
|
|
Vertical shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.DiagonalUp">
|
|
<summary>
|
|
Diagonal Up shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.DiagonalDown">
|
|
<summary>
|
|
Diagonal Down shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.FromCorner">
|
|
<summary>
|
|
FromCorner shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingStyle.FromCenter">
|
|
<summary>
|
|
From Center shading style.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.GradientShadingVariant">
|
|
<summary>
|
|
Shading variants for background gradient.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingVariant.ShadingUp">
|
|
<summary>
|
|
Shading in the upper part.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingVariant.ShadingDown">
|
|
<summary>
|
|
Shading in the lower part.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingVariant.ShadingOut">
|
|
<summary>
|
|
Shading in upper and lower parts.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GradientShadingVariant.ShadingMiddle">
|
|
<summary>
|
|
Shading in the middle.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FormFieldType">
|
|
<summary>
|
|
Specifies the type of a form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FormFieldType.TextInput">
|
|
<summary>
|
|
Text form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FormFieldType.CheckBox">
|
|
<summary>
|
|
Check box form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FormFieldType.DropDown">
|
|
<summary>
|
|
Drop-down form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FormFieldType.Unknown">
|
|
<summary>
|
|
Unknown form field.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.CheckBoxSizeType">
|
|
<summary>
|
|
Defines checkBox size type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CheckBoxSizeType.Auto">
|
|
<summary>
|
|
Auto check box size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CheckBoxSizeType.Exactly">
|
|
<summary>
|
|
Exact check box size.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextFormat">
|
|
<summary>
|
|
Defines TextFormat
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextFormat.None">
|
|
<summary>
|
|
No text formatting
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextFormat.Uppercase">
|
|
<summary>
|
|
Uppercase text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextFormat.Lowercase">
|
|
<summary>
|
|
Lowercase text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextFormat.FirstCapital">
|
|
<summary>
|
|
First capital text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextFormat.Titlecase">
|
|
<summary>
|
|
Title case text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextAlignment">
|
|
<summary>
|
|
A 16-bit unsigned integer that specifies vertical font alignment for East Asian languages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextAlignment.Top">
|
|
<summary>
|
|
This value specifies that characters are aligned based on the top of each character.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextAlignment.Center">
|
|
<summary>
|
|
This value specifies that characters are centered on the line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextAlignment.Baseline">
|
|
<summary>
|
|
This value specifies that characters are aligned based on their baseline.
|
|
This is how standard Latin text is displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextAlignment.Bottom">
|
|
<summary>
|
|
This value specifies that characters are aligned based on the bottom of each character.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextAlignment.Auto">
|
|
<summary>
|
|
This value specifies that alignment is automatically determined by the application.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.NumberFormat">
|
|
<summary>
|
|
Defines Number format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.None">
|
|
<summary>
|
|
No formatting
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.WholeNumber">
|
|
<summary>
|
|
Format with while number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.FloatingPoint">
|
|
<summary>
|
|
Format with floating point number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.WholeNumberPercent">
|
|
<summary>
|
|
Whole number in percents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.FloatingPointPercent">
|
|
<summary>
|
|
Floating point number in percents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.WholeNumberWithSpace">
|
|
<summary>
|
|
Format which suits to "#?#0" Word format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.FloatingPointWithSpace">
|
|
<summary>
|
|
Format which suites to "#?#0,00" Word format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberFormat.CurrencyFormat">
|
|
<summary>
|
|
Format which suites to "#?#0,00 $;(#?#0,00 $)" Word format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextDirection">
|
|
<summary>
|
|
Defines the direction of text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.TopToBottom">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from left to right horizontally,
|
|
then top to bottom vertically on the page.
|
|
This means that horizontal lines are filled before the text expands vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.RightToLeftRotated">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from top to bottom vertically,
|
|
then right to left horizontally on the page.
|
|
This means that horizontal lines are filled before the text expands vertically.
|
|
This flow is also rotated such that all text is rotated 90 degrees when displayed on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.LeftToRight">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from bottom to top vertically,
|
|
then from left to right horizontally on the page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.RightToLeft">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from right to left horizontally,
|
|
then top to bottom vertically on the page.
|
|
This means that horizontal lines are filled before the text expands vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.TopToBottomRotated">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from left to right horizontally,
|
|
then top to bottom vertically on the page.
|
|
This means that horizontal lines are filled before the text expands vertically.
|
|
This flow is also rotated such that any East Asian text shall be rotated 270 degrees when displayed on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.TextDirection.LeftToRightRotated">
|
|
<summary>
|
|
Specifies that text in the parent object shall flow from top to bottom vertically,
|
|
then left to right horizontally on the page.
|
|
This means that horizontal lines are filled before the text expands vertically.
|
|
This flow is also rotated such that all text is rotated 90 degrees when displayed on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FieldMarkType">
|
|
<summary>
|
|
Defines types of field marks.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldMarkType.FieldSeparator">
|
|
<summary>
|
|
Field separator type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldMarkType.FieldEnd">
|
|
<summary>
|
|
Field end type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BuiltinStyle">
|
|
<summary>
|
|
Defines built-in styles.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.DefaultTableStyle">
|
|
<summary>
|
|
Defines built-in table styles
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.BorderSide">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PageNumberStyle">
|
|
<summary>
|
|
Specifies the Number Style for a page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.PageNumberAlignment">
|
|
<summary>
|
|
Specifies PageNumber alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageNumberAlignment.Left">
|
|
<summary>
|
|
Aligns the page number to the left side of the page
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageNumberAlignment.Center">
|
|
<summary>
|
|
Centers the page number horizontally on the page
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageNumberAlignment.Right">
|
|
<summary>
|
|
Aligns the page number to the right side of the page
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageNumberAlignment.Inside">
|
|
<summary>
|
|
Aligns the page to the inside margin of the page (useful for double-sided printing)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.PageNumberAlignment.Outside">
|
|
<summary>
|
|
Aligns the page to the outside margin of the page (useful for double-sided printing)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FrameHorzAnchor">
|
|
<summary>
|
|
Specifies the horizontal frame anchor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FrameVertAnchor">
|
|
<summary>
|
|
Specifies the vertical frame anchor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.XHTMLValidationType">
|
|
<summary>
|
|
Specifies the XHTMLValidation type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.XHTMLValidationType.Strict">
|
|
<summary>
|
|
XHTML 1.0 validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.XHTMLValidationType.Transitional">
|
|
<summary>
|
|
XHTML 1.1 validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.XHTMLValidationType.None">
|
|
<summary>
|
|
No validation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.GridPitchType">
|
|
<summary>
|
|
Defines the type of grid pitch.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GridPitchType.NoGrid">
|
|
<summary>
|
|
No doucment grid.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GridPitchType.CharsAndLine">
|
|
<summary>
|
|
Line and Character Grid.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GridPitchType.LinesOnly">
|
|
<summary>
|
|
Line Grid Only.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GridPitchType.SnapToChars">
|
|
<summary>
|
|
Character Grid Only.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.DocumentVersion">
|
|
<summary>
|
|
Defines document version
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentVersion.Word97">
|
|
<summary>
|
|
Document created using Word 97
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentVersion.Word2000">
|
|
<summary>
|
|
Document created using Word 2000
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentVersion.Word2002">
|
|
<summary>
|
|
Document created using Word 2002
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentVersion.Word2003">
|
|
<summary>
|
|
Document created using Word 2003
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.DocumentVersion.Word2007">
|
|
<summary>
|
|
Document created using Word 2007
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.CommentMarkType">
|
|
<summary>
|
|
Defines types of comment mark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CommentMarkType.CommentStart">
|
|
<summary>
|
|
Comment start mark type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.CommentMarkType.CommentEnd">
|
|
<summary>
|
|
Comment end mark type
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.OleLinkType">
|
|
<summary>
|
|
Defines types of the ole object field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleLinkType.None">
|
|
<summary>
|
|
No specific type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleLinkType.Embed">
|
|
<summary>
|
|
Ole object field type is EMBED
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleLinkType.Link">
|
|
<summary>
|
|
Ole object field type is LINK
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleLinkType.Control">
|
|
<summary>
|
|
Ole object field type is Control.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.OleObjectType">
|
|
<summary>
|
|
defines the types of OLE object
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.Undefined">
|
|
<summary>
|
|
Type is not defined
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.AdobeAcrobatDocument">
|
|
<summary>
|
|
Adobe Acrobat Document. File has ".pdf" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.BitmapImage">
|
|
<summary>
|
|
Bitmap Image. File has ".png" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.MediaClip">
|
|
<summary>
|
|
Media Clip
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.Equation">
|
|
<summary>
|
|
Equation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.GraphChart">
|
|
<summary>
|
|
Graph Chart
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.Excel_97_2003_Worksheet">
|
|
<summary>
|
|
Excel 97-2003 Worksheet. File has ".xls" extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.ExcelBinaryWorksheet">
|
|
<summary>
|
|
Excel Binary Worksheet. File has ".xlsb" extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.ExcelChart">
|
|
<summary>
|
|
Excel chart. File has ".xls" extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.ExcelMacroWorksheet">
|
|
<summary>
|
|
Excel Macro-Enabled Worksheet. File has ".xlsm" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.ExcelWorksheet">
|
|
<summary>
|
|
Excel Worksheet. File has ".xlsx" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPoint_97_2003_Presentation">
|
|
<summary>
|
|
PowerPoint 97-2003 Presentation. File has ".ppt" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPoint_97_2003_Slide">
|
|
<summary>
|
|
PowerPoint 97-2003 Slide. File has ".sld" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPointMacroPresentation">
|
|
<summary>
|
|
PowerPoint Macro-Enabled Presentation. File has ".pptm" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPointMacroSlide">
|
|
<summary>
|
|
PowerPoint Macro-Enabled Slide. File has ".sldm" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPointPresentation">
|
|
<summary>
|
|
PowerPoint Presentation. File has ".pptx" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.PowerPointSlide">
|
|
<summary>
|
|
PowerPoint Slide. File has ".sldx" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.Word_97_2003_Document">
|
|
<summary>
|
|
Word 97-2003 Document. File has ".doc" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordDocument">
|
|
<summary>
|
|
Word Document. File has ".docx" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordMacroDocument">
|
|
<summary>
|
|
Word Macro-Enabled Document. File has ".docm" extension.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.VisioDrawing">
|
|
<summary>
|
|
Visio Deawing
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.MIDISequence">
|
|
<summary>
|
|
MIDI Sequence
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenDocumentPresentation">
|
|
<summary>
|
|
OpenDocument Presentation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenDocumentSpreadsheet">
|
|
<summary>
|
|
OpenDocument Spreadsheet
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenDocumentText">
|
|
<summary>
|
|
OpenDocument Text
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenOfficeSpreadsheet1_1">
|
|
<summary>
|
|
OpenOffice.org 1.1 Spreadsheet
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenOfficeText_1_1">
|
|
<summary>
|
|
OpenOffice.org 1.1 Text
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.Package">
|
|
<summary>
|
|
Package
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.VideoClip">
|
|
<summary>
|
|
Video Clip
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WaveSound">
|
|
<summary>
|
|
Wave Sound
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordPadDocument">
|
|
<summary>
|
|
WordPad Document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenOfficeSpreadsheet">
|
|
<summary>
|
|
OpenOffice spreadsheet
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.OpenOfficeText">
|
|
<summary>
|
|
OpenOffice Text
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.VisioDrawing_2013">
|
|
<summary>
|
|
Visio Deawing for visio 2013.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordPicture">
|
|
<summary>
|
|
word picture
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.MathType">
|
|
<summary>
|
|
Equation DSMT4
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordTemplate">
|
|
<summary>
|
|
Word.Template.12
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.OleObjectType.WordMacroTemplate">
|
|
<summary>
|
|
Microsoft Word Macro-Enabled Template
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ImageType">
|
|
<summary>
|
|
Specifies the image type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImageType.Bitmap">
|
|
<summary>
|
|
Represents a bitmap image format (e.g., BMP, PNG, JPEG).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImageType.Metafile">
|
|
<summary>
|
|
Represents a metafile format (e.g., WMF, EMF).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.RtfTokenType">
|
|
<summary>
|
|
Represents the different types of tokens that can be encountered when parsing RTF (Rich Text Format) content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.GroupStart">
|
|
<summary>
|
|
A group start token (e.g., \{)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.GroupEnd">
|
|
<summary>
|
|
A group end token (e.g., \})
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.ControlWord">
|
|
<summary>
|
|
A control word (e.g., \par, \b, \i)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.Text">
|
|
<summary>
|
|
A plain text token
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.TableEntry">
|
|
<summary>
|
|
A table entry marker
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.RtfTokenType.Unknown">
|
|
<summary>
|
|
Unknown type
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FieldCharType">
|
|
<summary>
|
|
Represents the different types of characters that can be used in a field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldCharType.Begin">
|
|
<summary>
|
|
The character is a start character, which defines the start of a complex field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldCharType.Seperate">
|
|
<summary>
|
|
The character is a separator character, which defines the end of the field codes and the start of the field result for a complex field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldCharType.End">
|
|
<summary>
|
|
The character is a end character, which defines the end of a complex field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldCharType.Unknown">
|
|
<summary>
|
|
Unknown
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FieldCharType.SimpleField">
|
|
<summary>
|
|
Simple field.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.LigatureType">
|
|
<summary>
|
|
Specifies the ligature type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.NumberFormType">
|
|
<summary>
|
|
Specifies the number form type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.NumberSpaceType">
|
|
<summary>
|
|
Specifies the number spacing type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberSpaceType.Default">
|
|
<summary>
|
|
Apply the default number spacing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberSpaceType.Proportional">
|
|
<summary>
|
|
Apply the proportional number spacing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.NumberSpaceType.Tabular">
|
|
<summary>
|
|
Apply the tabular number spacing.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.StylisticSetType">
|
|
<summary>
|
|
Specifies the stylistic set type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FontTypeHint">
|
|
<summary>
|
|
Defines the FontTypeHint enumeration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontTypeHint.Default">
|
|
<summary>
|
|
High ANSI Font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontTypeHint.EastAsia">
|
|
<summary>
|
|
East Asian Font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontTypeHint.ComplexScript">
|
|
<summary>
|
|
Complex Script Font.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.ImportOptions">
|
|
<summary>
|
|
Specifies the Importing document options.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImportOptions.UseDestinationStyles">
|
|
<summary>
|
|
Use the destination document's styles for the imported content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImportOptions.KeepSourceFormatting">
|
|
<summary>
|
|
Keep the source document's formatting intact.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImportOptions.MergeFormatting">
|
|
<summary>
|
|
Merge the source document's formatting with the destination document's styles.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.ImportOptions.KeepTextOnly">
|
|
<summary>
|
|
Import only the text content, discarding all formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.GroupedShapeOrigin">
|
|
<summary>
|
|
Specify vertical/horizontal origin the object in the GroupedShape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GroupedShapeOrigin.UpperLeftCorner">
|
|
<summary>
|
|
On the upper left corner.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.GroupedShapeOrigin.Center">
|
|
<summary>
|
|
Center.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.FontPitch">
|
|
<summary>
|
|
Represents the font pitch.
|
|
</summary>
|
|
<remarks>The pitch indicates if the font is fixed pitch, proportionally spaced, or relies on a default setting.</remarks>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontPitch.Default">
|
|
<summary>
|
|
Specifies that no information is available about the pitch of a font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontPitch.Fixed">
|
|
<summary>
|
|
Specifies that this is a fixed width font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.FontPitch.Variable">
|
|
<summary>
|
|
Specifies that this is a proportional width font.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.EditingGroup">
|
|
<summary>
|
|
This simple type specifies the set of possible aliases (or editing groups) which can be used as aliases to
|
|
determine if the current user shall be allowed to edit a single range defined by a range permission with
|
|
in a document. This mechanism simply provides a set of predefined editing groups which can be associated
|
|
with accounts by applications in any desired manner.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.None">
|
|
<summary>
|
|
No users.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Current">
|
|
<summary>
|
|
The current user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Editors">
|
|
<summary>
|
|
Editors of the documnet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Owners">
|
|
<summary>
|
|
Owners of the documnet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Contributors">
|
|
<summary>
|
|
Contributors to the documnet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Administrators">
|
|
<summary>
|
|
Members of the administrator group on the computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Everyone">
|
|
<summary>
|
|
All users.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Documents.EditingGroup.Default">
|
|
<summary>
|
|
Represents the default type, which is None.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextBodySelection">
|
|
<summary>
|
|
Represents a selection of part of text body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodySelection.TextBody">
|
|
<summary>
|
|
Gets the text body.
|
|
</summary>
|
|
<value>The text body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodySelection.ItemStartIndex">
|
|
<summary>
|
|
Gets or sets the start index of the text body item.
|
|
</summary>
|
|
<value>The start index of the item.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodySelection.ItemEndIndex">
|
|
<summary>
|
|
Gets or sets the end index of the text body item.
|
|
</summary>
|
|
<value>The end index of the item.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodySelection.ParagraphItemStartIndex">
|
|
<summary>
|
|
Gets or sets the start index of the paragraph item.
|
|
</summary>
|
|
<value>The start index of the item.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextBodySelection.ParagraphItemEndIndex">
|
|
<summary>
|
|
Gets or sets the end index of the paragraph item.
|
|
</summary>
|
|
<value>The end index of the item.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodySelection.#ctor(Spire.Doc.Fields.ParagraphBase,Spire.Doc.Fields.ParagraphBase)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodySelection"/> class.
|
|
</summary>
|
|
<param name="itemStart">The item start.</param>
|
|
<param name="itemEnd">The item end.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextBodySelection.#ctor(Spire.Doc.Interface.IBody,System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextBodySelection"/> class.
|
|
</summary>
|
|
<param name="textBody">The text body.</param>
|
|
<param name="itemStartIndex">Start index of the item.</param>
|
|
<param name="itemEndIndex">End index of the item.</param>
|
|
<param name="pItemStartIndex">Start index of the paragraph item.</param>
|
|
<param name="pItemEndIndex">End index of the paragraph item.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Documents.TextSelection">
|
|
<summary>
|
|
Represent a selection of text inside paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextSelection.SelectedText">
|
|
<summary>
|
|
Gets the selected text.
|
|
</summary>
|
|
<value>The selected text.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextSelection.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the <see cref="T:System.String"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Documents.TextSelection.Count">
|
|
<summary>
|
|
Gets the count of text chunks.
|
|
</summary>
|
|
<value>The count.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.#ctor(Spire.Doc.Documents.Paragraph,Spire.Doc.Documents.Paragraph,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Documents.TextSelection"/> class.
|
|
</summary>
|
|
<param name="para">The paragraph.</param>
|
|
<param name="startCharPos">The start char position.</param>
|
|
<param name="endCharPos">The end char position.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.#ctor(Spire.Doc.Documents.Paragraph,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the TextSelection class with the specified paragraph and character positions.
|
|
</summary>
|
|
<param name="para">The paragraph containing the text selection.</param>
|
|
<param name="startCharPos">The starting character position of the selection.</param>
|
|
<param name="endCharPos">The ending character position of the selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetRanges">
|
|
<summary>
|
|
Gets the ranges in one paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetAsRange">
|
|
<summary>
|
|
Gets as range.more than one paragraph, every paragraph to one text range.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetAsRange(System.Boolean)">
|
|
<summary>
|
|
Returns an array of TextRange objects representing the selected text in the RichTextBox control.
|
|
If isCopyFormat is true, the format of the selected text is also copied to the clipboard.
|
|
</summary>
|
|
<param name="isCopyFormat">Indicates whether to copy the format of the selected text to the clipboard.</param>
|
|
<returns>An array of TextRange objects representing the selected text.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetAsOneRange">
|
|
<summary>
|
|
Gets as one range.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetAsOneRange(System.Boolean)">
|
|
<summary>
|
|
Gets as one range.
|
|
</summary>
|
|
<param name="IsCopyFormat">Is copy existing formats to textrange</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Documents.TextSelection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownSaveAsHtml.None">
|
|
<summary>
|
|
Output entire content using pure Markdown syntax with no HTML passthrough.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownSaveAsHtml.Tables">
|
|
<summary>
|
|
Output tables as unprocessed HTML.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownLinkOutputMode.Auto">
|
|
<summary>
|
|
Auto-detect link export formats.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownLinkOutputMode.Inline">
|
|
<summary>
|
|
Serialize all links using inline Markdown syntax.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownLinkOutputMode.Reference">
|
|
<summary>
|
|
Serialize all links using reference Markdown syntax.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownListOutputMode.MarkdownSyntax">
|
|
<summary>
|
|
Produce list items formatted for Markdown syntax.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownListOutputMode.PlainText">
|
|
<summary>
|
|
Produce list items formatted for plain text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownOfficeMathOutputMode.Text">
|
|
<summary>
|
|
Serialize OfficeMath to plaint text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownOfficeMathOutputMode.Image">
|
|
<summary>
|
|
Serialize OfficeMath to Image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MarkdownOfficeMathOutputMode.MathML">
|
|
<summary>
|
|
Serialize OfficeMath to MathML.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.SaveOptions">
|
|
<summary>
|
|
This is an abstract base class for classes that allow the user to specify additional
|
|
options when saving a document into a particular format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SaveOptions.UseHighQualityRendering">
|
|
<summary>
|
|
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CssStyleSheetType">
|
|
<summary>
|
|
Represents the type of CSS style sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CssStyleSheetType.External">
|
|
<summary>
|
|
Specifies External sheet type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CssStyleSheetType.Internal">
|
|
<summary>
|
|
Specifies Internal sheet type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CssStyleSheetType.Inline">
|
|
<summary>
|
|
Specifies Inline sheet type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.MarkdownExportOptions">
|
|
<summary>
|
|
Class for customizing document conversion options to Markdown.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.MarkdownExportOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.TableTextAlignment">
|
|
<summary>
|
|
Controls how table text is aligned when saving to Markdown format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.ImagesFolder">
|
|
<summary>
|
|
Defines the output directory for iamges during Markdown document conversion.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.ImagesFolderAlias">
|
|
<summary>
|
|
Defines the directory name for building images URIs in exported documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.ImagesAsBase64">
|
|
<summary>
|
|
Determines if images are embedded as Base64 in the output file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.ListOutputMode">
|
|
<summary>
|
|
Defines the method for writing list items to the output file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.SaveUnderlineFormatting">
|
|
<summary>
|
|
Controls whether underlined text is converted to "++" syntax in Markdown format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.LinkOutputMode">
|
|
<summary>
|
|
Defines the formatting method for hyperlinks in output documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.OfficeMathOutputMode">
|
|
<summary>
|
|
Defines the rendering method for OfficeMath equations in output documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.MarkdownExportOptions.SaveAsHtml">
|
|
<summary>
|
|
Enables selection of elements to output as raw HTML in Markdown conversion.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.TableTextAlignment">
|
|
<summary>
|
|
The alignment of the text of the table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TableTextAlignment.Auto">
|
|
<summary>
|
|
Default alignment for table text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TableTextAlignment.Left">
|
|
<summary>
|
|
The table text is aligned to the Left.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TableTextAlignment.Center">
|
|
<summary>
|
|
The table text is aligned to the Center.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TableTextAlignment.Right">
|
|
<summary>
|
|
The table text is aligned to the Right.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Border.ClearFormatting">
|
|
<summary>
|
|
Clears all formatting attributes of the border, resetting it to its default state.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Border.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified object is equal to the current object.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns><c>true</c> if the specified object is equal to the current object; otherwise, <c>false</c>.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Border.BorderType">
|
|
<summary>
|
|
Gets or sets the style type of the border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Border.LineWidth">
|
|
<summary>
|
|
Gets or sets width of the border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Border.Color">
|
|
<summary>
|
|
Gets or sets color of the border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Border.Space">
|
|
<summary>
|
|
Returns or setswidth of space to maintain between border and text within border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Border.Shadow">
|
|
<summary>
|
|
Setting to define if border should be drawn with shadow.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.BorderPositions">
|
|
<summary>
|
|
Enumerates the different types of borders that can be applied to elements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.None">
|
|
<summary>
|
|
Represents no border being applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Bottom">
|
|
<summary>
|
|
Represents a border at the bottom of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Left">
|
|
<summary>
|
|
Represents a border at the left side of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Right">
|
|
<summary>
|
|
Represents a border at the right side of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Top">
|
|
<summary>
|
|
Represents a border at the top of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Horizontal">
|
|
<summary>
|
|
Represents a horizontal border spanning across the element (typically bottom or top).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.Vertical">
|
|
<summary>
|
|
Represents a vertical border spanning along the side of the element (typically left or right).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.DiagonalDown">
|
|
<summary>
|
|
Represents a diagonal border from the top-left to the bottom-right of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.BorderPositions.DiagonalUp">
|
|
<summary>
|
|
Represents a diagonal border from the bottom-left to the top-right of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CellPr.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.CellPr"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellPr.TextDirection">
|
|
<summary>
|
|
Gets or sets cell text direction.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Frame">
|
|
<summary>
|
|
Represents Frame object used in framed document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameAnchorLock">
|
|
<summary>
|
|
Gets or sets whether lock the anchor of Frame or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameWidthRule">
|
|
<summary>
|
|
Gets or sets Width Rule of Frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameHeightRule">
|
|
<summary>
|
|
Gets or sets Height Rule of Frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.WrapFrameAround">
|
|
<summary>
|
|
Gets or sets wrap type of Frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameHorizontalOrigin">
|
|
<summary>
|
|
Gets or sets relative to what the frame is positioned horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameVerticalOrigin">
|
|
<summary>
|
|
gets or sets relative to what the frame is positioned vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameHorizontalAlignment">
|
|
<summary>
|
|
Gets or sets the horizontal alignment of the frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameVerticalAlignment">
|
|
<summary>
|
|
Gets or sets the vertical alignment of the frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameHorizontalPosition">
|
|
<summary>
|
|
Gets or sets the horizontal position of the frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.FrameVerticalPosition">
|
|
<summary>
|
|
Gets or sets the vertical position of the frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Frame.IsFrame">
|
|
<summary>
|
|
Gets a value indicating whether this instance is frame.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetWidth">
|
|
<summary>
|
|
Gets width of this frame
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetWidth(System.Single)">
|
|
<summary>
|
|
Sets width of this frame
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetHeight">
|
|
<summary>
|
|
Gets height of this frame
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetHeight(System.Single)">
|
|
<summary>
|
|
Sets height of this frame
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetHorizontalPosition">
|
|
<summary>
|
|
Gets the position of the left edge of the frame
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetHorizontalPosition(System.Single)">
|
|
<summary>
|
|
Sets the position of the left edge of the frame
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetVerticalPosition">
|
|
<summary>
|
|
Gets the position of the top edge of the frame
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetVerticalPosition(System.Single)">
|
|
<summary>
|
|
Sets the position of the top edge of the frame
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetHorizontalDistanceFromText">
|
|
<summary>
|
|
Gets the distance between the document text and left or right edge of the frame.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetHorizontalDistanceFromText(System.Single)">
|
|
<summary>
|
|
Sets the distance between the document text and left or right edge of the frame.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.GetVerticalDistanceFromText">
|
|
<summary>
|
|
Gets the distance between the document text and top or bottom edge of the frame.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Frame.SetVerticalDistanceFromText(System.Single)">
|
|
<summary>
|
|
Sets the distance between the document text and top or bottom edge of the frame.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.#ctor">
|
|
<summary>
|
|
Default constructor initializing with no document reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Constructor initializing with a document reference.
|
|
</summary>
|
|
<param name="doc">The document reference.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Detailed constructor initializing with a document and an owning object reference.
|
|
</summary>
|
|
<param name="doc">The document reference.</param>
|
|
<param name="owner">The owning object.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.HasKey(System.Int32)">
|
|
<summary>
|
|
Checks for the existence of a specific key.
|
|
</summary>
|
|
<param name="key">The key to check.</param>
|
|
<returns><c>true</c> if the key exists; otherwise, <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.ClearFormatting">
|
|
<summary>
|
|
Clears all formatting properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.ClearBackground">
|
|
<summary>
|
|
Clears background-related formatting properties (if any).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.CopyPropertiesTo(Spire.Doc.Formatting.FormatBase,System.Int32)">
|
|
<summary>
|
|
Copies the properties of the current object to the destination format object for a specific key.
|
|
Handles complex types implementing IComplexAttr, ensuring they are cloned if not inherited.
|
|
Assumes other types are immutable and assigns them directly.
|
|
</summary>
|
|
<param name="destFormat">The destination format object to copy properties to.</param>
|
|
<param name="key">The key associated with the properties to be copied.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.FormatBase.CopyPropertiesFrom(Spire.Doc.Formatting.FormatBase)">
|
|
<summary>
|
|
Copies properties from the specified source format to the current format.
|
|
</summary>
|
|
<param name="srcFormat">The source format from which properties will be copied.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Paddings">
|
|
<summary>
|
|
Represents a collection of padding attributes for formatting text in a Word document.
|
|
</summary>public class Paddings : WordAttrCollection
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Paddings.Left">
|
|
<summary>
|
|
Gets or sets left padding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Paddings.Top">
|
|
<summary>
|
|
Gets or sets top padding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Paddings.Right">
|
|
<summary>
|
|
Gets or sets right padding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Paddings.Bottom">
|
|
<summary>
|
|
Gets or sets bottom padding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Paddings.All">
|
|
<summary>
|
|
Sets all paddings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Paddings.ClearFormatting">
|
|
<summary>
|
|
Clears the table positioning.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Paddings.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the current object is equal to another object of the same type.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns>
|
|
true if the current object is equal to the obj parameter; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.Paddings.Equals(Spire.Doc.Formatting.Paddings)">
|
|
<summary>
|
|
Determines whether the current object is equal to another object of the same type.
|
|
</summary>
|
|
<param name="other">An object to compare with this object.</param>
|
|
<returns>true if the current object is equal to the other parameter; otherwise, false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Revisions.EditRevision">
|
|
<summary>
|
|
Represents info about an insert or delete revision, occurs on runs of text.
|
|
|
|
Three different revision operations are possible on a run: inserted, deleted or formatted.
|
|
Formatted revision can be combined with deleted or inserted revision.
|
|
A piece of text can be inserted by one author and deleted by another author,
|
|
in this case both insert and delete revisions can be present on a run.
|
|
|
|
1. Formatted is same as formatting change revision on other objects, for example section properties.
|
|
There is an sprm that is followed by sprms for the properties that have changed. We read this
|
|
into revision attributes collection and store it as an attribute in the run attribute collection.
|
|
2. Inserted and deleted in WordML actually come not inside rPr element, but at the level of the r element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Revisions.EditRevision.Type">
|
|
<summary>
|
|
Indicates whether the run is inserted or deleted during the revision.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Revisions.EditRevisionType">
|
|
<summary>
|
|
The type of revision mark. Note that MS Word VBA defines many different revision types that
|
|
are not really documented and I don't know if they are used or not, for example wdRevisionDisplayField.
|
|
|
|
Revision types are much simpler in WordML so this enumeration is more similar to WordML than to MS Word VBA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.Revisions.EditRevisionType.Insertion">
|
|
<summary>
|
|
Type of revision mark is insertion.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.Revisions.EditRevisionType.Deletion">
|
|
<summary>
|
|
Type of revision mark is Deletion.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Revisions.MoveRevision">
|
|
<summary>
|
|
Represents info about an moveFrom or moveTo revision, occurs on runs of text.
|
|
Two different move revision operations are possible on a run: moveFrom, and moveTo.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Revisions.MoveRevision.Type">
|
|
<summary>
|
|
Indicates whether the run is 'moved from' or 'moved to' during the revision.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Revisions.MoveRevisionType">
|
|
<summary>
|
|
The type of move revision mark.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.Revisions.RevisionBase">
|
|
<summary>
|
|
Common base for all revisions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Revisions.RevisionBase.Author">
|
|
<summary>
|
|
Gets or sets the author.
|
|
Specifies the author for an annotation within a Word document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.Revisions.RevisionBase.DateTime">
|
|
<summary>
|
|
Gets or sets the date time.
|
|
Specifies the date information for an annotation within a Word document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.ViewSetup">
|
|
<summary>
|
|
Represents a setup configuration for a view, inheriting from DocumentSerializable for document-based serialization.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Formatting.ViewSetup.DEF_ZOOMING">
|
|
<summary>
|
|
Constant value for Zoom.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ViewSetup.ZoomPercent">
|
|
<summary>
|
|
Returns or sets zooming value in percents
|
|
</summary>
|
|
<value>The zoom percent.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ViewSetup.ZoomType">
|
|
<summary>
|
|
Returns or sets zooming type
|
|
</summary>
|
|
<value>The type of the zoom.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ViewSetup.DocumentViewType">
|
|
<summary>
|
|
Returns or sets document view mode
|
|
</summary>
|
|
<value>The type of the document view.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ViewSetup.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Creates PageSetup object for specified document.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.CommentFormat">
|
|
<summary>
|
|
Represents a class for formatting comments.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CommentFormat.DateTime">
|
|
<summary>
|
|
Gets or sets the DateTime.
|
|
</summary>
|
|
<value>The DateTime.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CommentFormat.Initial">
|
|
<summary>
|
|
Gets or sets the user initials.
|
|
</summary>
|
|
<value>The user initials.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CommentFormat.Author">
|
|
<summary>
|
|
Gets or sets the user.
|
|
</summary>
|
|
<value>The user.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CommentFormat.CommentId">
|
|
<summary>
|
|
Gets or sets the id of the comment.
|
|
</summary>
|
|
<value>The comment id.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CommentFormat.#ctor(Spire.Doc.Fields.Comment)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:WCommentFormat"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CommentFormat.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the CommentFormat class with the specified document.
|
|
</summary>
|
|
<param name="document">The document to which the comment format will be applied.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CommentFormat.Clone(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Creates a new object that is a copy of the current instance.
|
|
</summary>
|
|
<returns>
|
|
A new object that is a copy of this instance.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ListFormat.ListLevelNumber">
|
|
<summary>
|
|
Returns or sets list nesting level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ListFormat.ListType">
|
|
<summary>
|
|
Gets type of the list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ListFormat.CurrentListRef">
|
|
<summary>
|
|
Gets or sets the current list reference. If the list Id is zero, returns null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ListFormat.CurrentListLevel">
|
|
<summary>
|
|
Gets the current list level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.IncreaseIndentLevel">
|
|
<summary>
|
|
Increase level indent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.DecreaseIndentLevel">
|
|
<summary>
|
|
Decrease level indent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ContinueListNumbering">
|
|
<summary>
|
|
Continue last list.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ApplyStyle(System.String)">
|
|
<summary>
|
|
Applies a list style to the current context by the specified style name.
|
|
If the style is not found, it throws an ArgumentNullException.
|
|
</summary>
|
|
<param name="listStyleName">The name of the list style to apply.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ApplyStyle(Spire.Doc.Documents.ListStyle)">
|
|
<summary>
|
|
Applies the specified list style to the current paragraph.
|
|
If the style contains a list definition reference,
|
|
it applies the list reference; otherwise, it removes the list.
|
|
</summary>
|
|
<param name="listStyle">The list style to apply.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ApplyBulletStyle">
|
|
<summary>
|
|
Apply default bullet style for current paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ApplyNumberedStyle">
|
|
<summary>
|
|
Apply default numbered style for current paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.ApplyListRef(Spire.Doc.Documents.ListDefinitionReference,System.Int32)">
|
|
<summary>
|
|
Applies a style to a list by setting its identifier and level number.
|
|
</summary>
|
|
<param name="list">The list reference to which the style is applied.</param>
|
|
<param name="leverNumber">The level number of the list item.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ListFormat.RemoveList">
|
|
<summary>
|
|
Removes the list from current paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.WordAttributeBase.#ctor(Spire.Doc.Document,Spire.Doc.OwnerHolder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.WordAttributeBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.Borders">
|
|
<summary>
|
|
Gets the Borders object associated with the current instance, creating it if necessary.
|
|
</summary>
|
|
<returns>The Borders object.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.Paddings">
|
|
<summary>
|
|
Gets the padding settings for the table.
|
|
</summary>
|
|
<returns>A Paddings object containing the padding settings.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.Positioning">
|
|
<summary>
|
|
Gets the positioning of the table.
|
|
</summary>
|
|
<returns>The <see cref="T:Spire.Doc.Formatting.TablePositioning"/> object representing the positioning of the table.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.TableOption">
|
|
<summary>
|
|
Gets or sets the table style options.
|
|
</summary>
|
|
<value>The table style options.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.PreferredWidth">
|
|
<summary>
|
|
Gets or sets the preferred width of the table.
|
|
</summary>
|
|
<returns>The preferred width of the table.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.CellSpacing">
|
|
<summary>
|
|
Gets or sets the cell spacing of the table.
|
|
</summary>
|
|
<value>
|
|
The cell spacing in pixels. If the value is less than or equal to 0, the spacing is set to 0. If the value is between 0 and 264.5, it is divided by 2 to set the actual spacing.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.LeftIndent">
|
|
<summary>
|
|
Gets or sets the left indent of the table.
|
|
</summary>
|
|
<value>
|
|
The left indent value as a float.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.Bidi">
|
|
<summary>
|
|
Gets or sets the bidirectional text setting for the table.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the text should be displayed in a bidirectional format; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.HorizontalAlignment">
|
|
<summary>
|
|
Gets or sets the horizontal alignment of the rows in the table.
|
|
</summary>
|
|
<value>The horizontal alignment.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.WrapTextAround">
|
|
<summary>
|
|
Gets or sets a value indicating whether text should wrap around an object.
|
|
</summary>
|
|
<returns>
|
|
true if text should wrap around an object; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.LayoutType">
|
|
<summary>
|
|
Gets or sets the layout type of the table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TableFormat.AllowAutoFit">
|
|
<summary>
|
|
Gets or sets a value indicating whether the layout should automatically fit the content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TableFormat.ClearFormatting">
|
|
<summary>
|
|
Clears the formatting for all rows in the table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TableFormat.ClearBackground">
|
|
<summary>
|
|
Clears the background shading from all rows in the table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TableFormat.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the current object is equal to another object.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns>true if the current object is equal to the obj parameter; otherwise, false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.TextBoxFormat">
|
|
<summary>
|
|
Represents TextBox formatting.
|
|
</summary>public class TextBoxFormat : WordAttrCollection
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.HorizontalOrigin">
|
|
<summary>
|
|
Gets or sets horizontal origin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.VerticalOrigin">
|
|
<summary>
|
|
Gets or sets vertical origin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.FillColor">
|
|
<summary>
|
|
Gets or sets the fill color of the textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.FillEfects">
|
|
<summary>
|
|
Gets the fill effects.
|
|
</summary>
|
|
<value>The fill effects.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.LineStyle">
|
|
<summary>
|
|
Get or set text box linestyle
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.Width">
|
|
<summary>
|
|
Gets or sets textbox width
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.Height">
|
|
<summary>
|
|
Gets or sets textbox height
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.LineColor">
|
|
<summary>
|
|
Gets or sets line color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.NoLine">
|
|
<summary>
|
|
Gets or sets value which defines if
|
|
there is a line around textbox shape
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.HorizontalPosition">
|
|
<summary>
|
|
Get or set textbox horizontal position
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.IsFitShapeToText">
|
|
<summary>
|
|
Gets or Sets a value. Specifies whether the spape stretches to fit the text in the textbox.
|
|
Default is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.VerticalPosition">
|
|
<summary>
|
|
Get/set textbox vertical position
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.TextWrappingStyle">
|
|
<summary>
|
|
Get/set text Wrapping style
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.TextWrappingType">
|
|
<summary>
|
|
Get/set wrapping type for textbox
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.LineWidth">
|
|
<summary>
|
|
Get/set textbox line width
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.LineDashing">
|
|
<summary>
|
|
Get/set line dashing for textbox
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.HorizontalAlignment">
|
|
<summary>
|
|
Get/set textbox horizontal alignment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.VerticalAlignment">
|
|
<summary>
|
|
Get/set textbox vertical alignment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.LayoutFlowAlt">
|
|
<summary>
|
|
Gets or sets the text direction of the textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.TextAnchor">
|
|
<summary>
|
|
Gets or sets the vertical anchoring of text. Default is top.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextBoxFormat.InternalMargin">
|
|
<summary>
|
|
Gets the internal margin.
|
|
</summary>
|
|
<value>The internal margin.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TextBoxFormat.#ctor(Spire.Doc.Fields.TextBox)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.TextBoxFormat"/> class.
|
|
</summary>
|
|
<param name="txtBox">the parent textbox.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TextBoxFormat.Clone">
|
|
<summary>
|
|
Clone textbox format.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.InternalMargin.All">
|
|
<summary>
|
|
Sets all internal margin.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.InternalMargin.Left">
|
|
<summary>
|
|
Gets or sets the internal left margin (in points).
|
|
</summary>
|
|
<value>The internal left margin.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.InternalMargin.Right">
|
|
<summary>
|
|
Gets or sets the internal right margin (in points).
|
|
</summary>
|
|
<value>The internal right margin.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.InternalMargin.Top">
|
|
<summary>
|
|
Gets or sets the internal top margin (in points).
|
|
</summary>
|
|
<value>The internal top margin.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.InternalMargin.Bottom">
|
|
<summary>
|
|
Gets or sets the internal bottom margin (in points).
|
|
</summary>
|
|
<value>The internal bottom margin.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.InternalMargin.#ctor(Spire.Doc.Fields.TextBox)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.InternalMargin"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.Borders">
|
|
<summary>
|
|
Gets the cell borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.Paddings">
|
|
<summary>
|
|
Gets the cell paddings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.VerticalAlignment">
|
|
<summary>
|
|
Gets or sets vertical alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.VerticalMerge">
|
|
<summary>
|
|
Returns or setsthe way of vertical merging of the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.HorizontalMerge">
|
|
<summary>
|
|
Returns or setsthe way of horizontal merging of the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.TextWrap">
|
|
<summary>
|
|
Gets or sets a value indicating whether [text wrap].
|
|
</summary>
|
|
<value><c>true</c> if it specifies text wrap, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.FitText">
|
|
<summary>
|
|
Gets or sets fit text option.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.TextDirection">
|
|
<summary>
|
|
Gets or sets cell text direction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.SamePaddingsAsTable">
|
|
<summary>
|
|
Defines whether to use same paddings as table has.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CellFormat.Shading">
|
|
<summary>
|
|
Gets the Shading attribute associated with cell.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CellFormat.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.CellFormat"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CellFormat.ClearFormatting">
|
|
<summary>
|
|
Clears the formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CellFormat.ClearBackground">
|
|
<summary>
|
|
Clears paragraph background.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.TablePositioning">
|
|
<summary>
|
|
Table Positioning
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.HorizPositionAbs">
|
|
<summary>
|
|
Gets or sets the absolute horizontal position for table.
|
|
</summary>
|
|
<value>The horiz position abs.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.VertPositionAbs">
|
|
<summary>
|
|
Gets or sets the absolute vertical position for table.
|
|
</summary>
|
|
<value>The horiz position abs.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.HorizPosition">
|
|
<summary>
|
|
Gets or sets the horizontal position for table.
|
|
</summary>
|
|
<value>The vertical position.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.VertPosition">
|
|
<summary>
|
|
Gets or sets the vertical position for table.
|
|
</summary>
|
|
<value>The vertical position.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.HorizRelationTo">
|
|
<summary>
|
|
Gets or sets the horizontal relation of the table.
|
|
</summary>
|
|
<value>The horiz relation to.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.VertRelationTo">
|
|
<summary>
|
|
Gets or sets the horizontal relation of the table.
|
|
</summary>
|
|
<value>The horiz relation to.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.DistanceFromTop">
|
|
<summary>
|
|
Gets or sets the distance from top.
|
|
</summary>
|
|
<value>The distance from top.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.DistanceFromBottom">
|
|
<summary>
|
|
Gets or sets the distance from bottom.
|
|
</summary>
|
|
<value>The distance from bottom.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.DistanceFromLeft">
|
|
<summary>
|
|
Gets or sets the distance from left.
|
|
</summary>
|
|
<value>The distance from left.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TablePositioning.DistanceFromRight">
|
|
<summary>
|
|
Gets or sets the distance from right.
|
|
</summary>
|
|
<value>The distance from right.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TablePositioning.ClearFormatting">
|
|
<summary>
|
|
Clears the table positioning.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.TablePositioning.Equals(System.Object)">
|
|
<summary>
|
|
Compares the current instance with another object of the same type to determine whether they are equal.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current instance.</param>
|
|
<returns>true if the current instance is equal to the obj parameter; otherwise, false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Formatting.TextEffectFormat">
|
|
<summary>
|
|
Represents a text effect format for text range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.TextEffectFormat.TextOpacity">
|
|
<summary>
|
|
set Text Opacity;
|
|
the value rangs from 0 to 1;
|
|
</summary>
|
|
<param name="value">The text opacity value.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontName">
|
|
<summary>
|
|
Returns or sets font name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontSize">
|
|
<summary>
|
|
Returns or sets font size
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Bold">
|
|
<summary>
|
|
Returns or sets bold style
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Italic">
|
|
<summary>
|
|
Returns or sets italic style
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.IsStrikeout">
|
|
<summary>
|
|
Returns or sets strikeout style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.DoubleStrike">
|
|
<summary>
|
|
Returns or sets double strikeout style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.UnderlineStyle">
|
|
<summary>
|
|
Returns or sets underline style
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.UnderlineColor">
|
|
<summary>
|
|
Returns or sets underline color
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.EmphasisMark">
|
|
<summary>
|
|
Returns or sets text emphasis mark
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.TextColor">
|
|
<summary>
|
|
Returns or sets text color
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.TextScale">
|
|
<summary>
|
|
Gets or sets a value specifies that the percentage by which the contents of a run shall be expanded or compressed
|
|
with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.TextBackgroundColor">
|
|
<summary>
|
|
Gets or sets text background color
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.SubSuperScript">
|
|
<summary>
|
|
Returns or sets subscript/superscript mode
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.CharacterSpacing">
|
|
<summary>
|
|
Returns or sets space width between characters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Position">
|
|
<summary>
|
|
Returns or sets text vertical position.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.IsShadow">
|
|
<summary>
|
|
Gets or sets shadow property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Emboss">
|
|
<summary>
|
|
Gets or sets emboss property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Engrave">
|
|
<summary>
|
|
Gets or sets Engrave property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Hidden">
|
|
<summary>
|
|
Gets or sets Hidden property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.AllCaps">
|
|
<summary>
|
|
Gets or sets AllCaps property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.IsSmallCaps">
|
|
<summary>
|
|
Gets or sets IsSmallCaps property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Bidi">
|
|
<summary>
|
|
Returns or sets right-to-left property of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.BoldBidi">
|
|
<summary>
|
|
Returns or sets bold property for right-to-left text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.ItalicBidi">
|
|
<summary>
|
|
Returns or sets italic property for right-to-left text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontSizeBidi">
|
|
<summary>
|
|
Returns or sets font size of the right-to-left text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.HighlightColor">
|
|
<summary>
|
|
Gets or sets highlight color of text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontNameAscii">
|
|
<summary>
|
|
Gets or setsthe font used for Latin text (characters with character codes from 0 through 127).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontNameBidi">
|
|
<summary>
|
|
Gets or sets font name for right-to-left text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontNameFarEast">
|
|
<summary>
|
|
Gets or sets East Asian font name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontNameNonFarEast">
|
|
<summary>
|
|
Gets or sets font used for characters with character codes from 128 through 255.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.FontTypeHint">
|
|
<summary>
|
|
Gets or sets the font type hint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.LocaleIdASCII">
|
|
<summary>
|
|
Gets or sets the ASCII locale id .
|
|
</summary>
|
|
<value>The ASCII locale id .</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.LocaleIdBi">
|
|
<summary>
|
|
Gets or sets the locale identifier(language) for formatted right-to-left characters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.LocaleIdFarEast">
|
|
<summary>
|
|
Gets or sets the far east locale id .
|
|
</summary>
|
|
<value>The far east locale id .</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Border">
|
|
<summary>
|
|
Gets a object that specifies border for the CharacterFormat.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Shading">
|
|
<summary>
|
|
Gets a object that refers to the shading formatting for the CharacterFormat.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.IsOutLine">
|
|
<summary>
|
|
Get/set outline character property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.Style">
|
|
<summary>
|
|
Gets or sets the style for the character format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.TextEffectFormat">
|
|
<summary>
|
|
Returns text effect format
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.LigaturesType">
|
|
<summary>
|
|
Gets or sets the ligatures type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.NumberFormType">
|
|
<summary>
|
|
Gets or sets the number form type.
|
|
</summary>
|
|
<value>The number form.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.NumberSpaceType">
|
|
<summary>
|
|
Gets or sets the number space type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.CharacterFormat.StylisticSetType">
|
|
<summary>
|
|
Gets or sets the stylistic set type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CharacterFormat.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CharacterFormat.ClearFormatting">
|
|
<summary>
|
|
Clears the formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.CharacterFormat.ClearBackground">
|
|
<summary>
|
|
Clears paragraph background.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.IsKinSoku">
|
|
<summary>
|
|
Get or Set a value that determines whether use Asian rules for controlling first and last characters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.FirstLineIndentChars">
|
|
<summary>
|
|
Gets or sets the value that represents the paragraph first line indent in character units.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.LeftIndentChars">
|
|
<summary>
|
|
Gets or sets the value that represents the paragraph left indent in character units.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.RightIndentChars">
|
|
<summary>
|
|
Gets or sets the value that represents the paragraph right indent in character units.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.IsBidi">
|
|
<summary>
|
|
Returns or sets right-to-left property of the paragraph.
|
|
</summary>
|
|
<value>if bidi, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.Shading">
|
|
<summary>
|
|
Gets or sets the shading of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.Borders">
|
|
<summary>
|
|
Gets the borders of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.Style">
|
|
<summary>
|
|
Gets or sets the paragraph style associated with paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.StyleName">
|
|
<summary>
|
|
Gets or sets the name of the current style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.Tabs">
|
|
<summary>
|
|
Gets the tabs info.
|
|
</summary>
|
|
<value>The tabs info.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.KeepLines">
|
|
<summary>
|
|
True if all lines in the paragraph are to remain on the same page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.KeepFollow">
|
|
<summary>
|
|
True if the paragraph is to remains on the same page as the
|
|
paragraph that follows it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.PageBreakBefore">
|
|
<summary>
|
|
True if a page break is forced before the paragraph
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.PageBreakAfter">
|
|
<summary>
|
|
True if a page break is forced after the paragraph
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.IsWidowControl">
|
|
<summary>
|
|
True if the first and last lines in the paragraph
|
|
are to remain on the same page as the rest of the paragraph.
|
|
</summary>
|
|
<remarks></remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.AutoSpaceDN">
|
|
<summary>
|
|
Gets or sets the value that determines whether the space is automatically adjusted between Asian text and numbers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.AutoSpaceDE">
|
|
<summary>
|
|
Gets or sets the value that determines whether the space is automatically adjusted between Asian and Latin text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.HorizontalAlignment">
|
|
<summary>
|
|
Returns or sets horizontal alignment for the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.LeftIndent">
|
|
<summary>
|
|
Returns or set sthe value that represents the left indent for paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.RightIndent">
|
|
<summary>
|
|
Returns or sets the value that represents the right indent for paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.FirstLineIndent">
|
|
<summary>
|
|
Gets or sets the value(in points) for first line or hanging indent.Positive
|
|
value represents first-line indent, and Negative value
|
|
represents hanging indent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.BeforeSpacing">
|
|
<summary>
|
|
Returns or sets the spacing (in points) before the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.AfterSpacing">
|
|
<summary>
|
|
Returns or sets the spacing (in points) after the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.BackColor">
|
|
<summary>
|
|
Gets or sets background color of the paragraph
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.LineSpacing">
|
|
<summary>
|
|
Returns or sets line spacing property of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.LineSpacingRule">
|
|
<summary>
|
|
Returns or sets line spacing rule property of the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.BeforeAutoSpacing">
|
|
<summary>
|
|
Gets or sets a value indicating whether spacing before is automatic.
|
|
</summary>
|
|
<value>if spacing before is automatic, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.AfterAutoSpacing">
|
|
<summary>
|
|
Gets or sets a value indicating whether spacing after is automatic.
|
|
</summary>
|
|
<value>if spacing after is automatic, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.SnapToGrid">
|
|
<summary>
|
|
Gets or sets a value specifies whether the current paragraph snaps to grid when document grid is defined.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.OutlineLevel">
|
|
<summary>
|
|
Gets or sets the outline level.
|
|
</summary>
|
|
<value>The outline level.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.OverflowPunc">
|
|
<summary>
|
|
Gets or set allow punctuation to extend past text extents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.WordWrap">
|
|
<summary>
|
|
Gets or sets a value that determines whether allow Latin text to wrap in the middle of a word.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.BeforeSpacingLines">
|
|
<summary>
|
|
Gets or sets a value specifies the spacing that should be added before the first line
|
|
in this paragraph in the document in line units.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.AfterSpacingLines">
|
|
<summary>
|
|
Gets or sets a value specifies the spacing that should be added after the last line
|
|
in this paragraph in the document in line units.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.TextAlignment">
|
|
<summary>
|
|
Gets or sets the style of textalignment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.MirrorIndents">
|
|
<summary>
|
|
Gets a value indicating whether indentation type is mirror indents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.SuppressAutoHyphens">
|
|
<summary>
|
|
Indicates whether to suppress automatic hyphenation for the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.IsFrame">
|
|
<summary>
|
|
Gets a value indicating whether the current object has frame format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.ParagraphFormat.Frame">
|
|
<summary>
|
|
Gets the frame format.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.ParagraphFormat"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.ParagraphFormat"/> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.SetLeftIndent(System.Single)">
|
|
<summary>
|
|
Sets the value that represents the left indent for paragraph.
|
|
</summary>
|
|
<param name="leftIndent">The left indent.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.SetRightIndent(System.Single)">
|
|
<summary>
|
|
Sets the value that represents the right indent for paragraph.
|
|
</summary>
|
|
<param name="rightIndent">The right indent.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.SetFirstLineIndent(System.Single)">
|
|
<summary>
|
|
Sets the value that represents the first line indent for paragraph.
|
|
</summary>
|
|
<param name="firstLineIndent">The first line indent.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.SetFirstLineIndentChars(System.Single)">
|
|
<summary>
|
|
Sets the value that represents the first line indent chars for paragraph.
|
|
</summary>
|
|
<param name="firstLineIndentChars">The first line indent chars.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.ClearFormatting">
|
|
<summary>
|
|
Clears the formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.ClearBackground">
|
|
<summary>
|
|
Clears paragraph background.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.ParagraphFormat.HasKey(System.Int32)">
|
|
<summary>
|
|
Determines if the property with the given key exists.
|
|
</summary>
|
|
<param name="propKey">The key of the property to check for existence.</param>
|
|
<returns>True if the property with the specified key exists; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.Borders">
|
|
<summary>
|
|
Gets the borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.Paddings">
|
|
<summary>
|
|
Gets the paddings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.Positioning">
|
|
<summary>
|
|
Gets the positioning.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.BackColor">
|
|
<summary>
|
|
Gets or sets background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.CellSpacing">
|
|
<summary>
|
|
Returns or sets spacing between cells.
|
|
The setting value must be between 0 pt and 264.5 pt.
|
|
The value will not be applied to this property if it is set out of range.
|
|
This property will be cleared if the set value is less than 0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.LeftIndent">
|
|
<summary>
|
|
Returns or sets table indent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.IsAutoResized">
|
|
<summary>
|
|
Returns or sets the boolean value indicating if table is auto resized
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.Bidi">
|
|
<summary>
|
|
Returns or sets whether table is right to left.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.HorizontalAlignment">
|
|
<summary>
|
|
Gets or sets horizontal alignment for the table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.WrapTextAround">
|
|
<summary>
|
|
Gets or sets a value indicating whether to use "Around" text wrapping.
|
|
</summary>
|
|
<value><c>true</c> if wrap text around; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.LayoutType">
|
|
<summary>
|
|
Gets or set the value of the layoutType.
|
|
This element specifies the algorithm which shall be used to layout the comtents of the table within the document.
|
|
</summary>
|
|
<value>The type of the layout.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.Height">
|
|
<summary>
|
|
Gets or sets the height of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.HeightType">
|
|
<summary>
|
|
Gets or sets the height type of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.IsHeader">
|
|
<summary>
|
|
Gets or sets a value indicating whether the table has a header.
|
|
rue if the row is repeated as a table heading on every page when the table spans more than one page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Formatting.RowFormat.IsBreakAcrossPages">
|
|
<summary>
|
|
Gets or sets a value indicating whether the table can break across pages.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.RowFormat.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Formatting.RowFormat"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.RowFormat.ClearFormatting">
|
|
<summary>
|
|
Clears the formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.RowFormat.ClearBackground">
|
|
<summary>
|
|
Clears background.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Formatting.RowFormat.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:Spire.Doc.Formatting.RowFormat" />, is equal to this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ICollectionBase">
|
|
<summary>
|
|
Represents base interface for dls collections.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ICollectionBase.Count">
|
|
<summary>
|
|
Gets the number of items in collection.
|
|
</summary>
|
|
<value>The count.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IDocumentCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.IDocument"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.IDocument"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IDocumentObjectCollection">
|
|
<summary>
|
|
Represents base interface for entities collections.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObjectCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.DocumentObject"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IStyleCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.IStyle"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IStyleCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.IStyle"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyleCollection.Add(Spire.Doc.Interface.IStyle)">
|
|
<summary>
|
|
Adds the specified style.
|
|
</summary>
|
|
<param name="style">The style.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyleCollection.FindByName(System.String)">
|
|
<summary>
|
|
Finds a first style with specified style name
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyleCollection.FindByName(System.String,Spire.Doc.Documents.StyleType)">
|
|
<summary>
|
|
Finds a style by style name and style type
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="styleType">Type of the style.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IParagraphCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.IParagraph"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraphCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.IParagraph"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraphCollection.Add(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Adds a paragraph to the end of collection.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraphCollection.Insert(System.Int32,Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Inserts a paragraph into collection at the specified index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<param name="paragraph">The paragraph.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraphCollection.IndexOf(Spire.Doc.Interface.IParagraph)">
|
|
<summary>
|
|
Returns the zero-based index of the specified paragraph.
|
|
</summary>
|
|
<param name="paragraph">The paragraph.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraphCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the paragraph at the specified index from the collection.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ITableCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.ITable"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITableCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ITable"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITableCollection.Add(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Adds a table to end of text body.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITableCollection.IndexOf(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Determines the index of a specific item in the collection.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITableCollection.Contains(Spire.Doc.Interface.ITable)">
|
|
<summary>
|
|
Determines whether the <see cref="!:Spire.Doc.ITableCollection"/> contains a specific value.
|
|
</summary>
|
|
<param name="table">The table.</param>
|
|
<returns>
|
|
if table is found, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ITextBoxItemCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="!:Spire.Doc.ITextBox"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITextBoxItemCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ITextBox"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITextBoxItemCollection.Add(Spire.Doc.Interface.ITextBox)">
|
|
<summary>
|
|
Adds a textbox to the collection.
|
|
</summary>
|
|
<param name="textBox">The text box.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ICompositeObject">
|
|
<summary>
|
|
Publishes base entity that can contains other entities.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ICompositeObject.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IDocumentObject">
|
|
<summary>
|
|
Represents a base entity for other entities of DLS.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.Document">
|
|
<summary>
|
|
Gets document of this entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.Owner">
|
|
<summary>
|
|
Gets owner of this document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.NextSibling">
|
|
<summary>
|
|
Gets the next sibling.
|
|
</summary>
|
|
<value>The next sibling.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.PreviousSibling">
|
|
<summary>
|
|
Gets the previous sibling.
|
|
</summary>
|
|
<value>The previous sibling.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentObject.IsComposite">
|
|
<summary>
|
|
Gets a value indicating whether this instance is composite.
|
|
</summary>
|
|
<value>
|
|
if this instance is composite, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentObject.Clone">
|
|
<summary>
|
|
Creates a duplicate of the document object.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentObject.GetNextWidgetSibling">
|
|
<summary>
|
|
Gets the next widget sibling.
|
|
</summary>
|
|
<value>The next widget sibling.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentObject.GetPreviousWidgetSibling">
|
|
<summary>
|
|
Gets the previous sibling.
|
|
</summary>
|
|
<value>The previous Widget sibling.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IBody">
|
|
<summary>
|
|
Interface publish text body functionality
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IBody.Tables">
|
|
<summary>
|
|
Gets inner tables.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IBody.Paragraphs">
|
|
<summary>
|
|
Gets inner paragraphs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IBody.FormFields">
|
|
<summary>
|
|
Gets the form fields.
|
|
</summary>
|
|
<value>The form fields.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IBody.LastParagraph">
|
|
<summary>
|
|
Gets the last paragraph.
|
|
</summary>
|
|
<value>The last paragraph.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.AddParagraph">
|
|
<summary>
|
|
Adds paragraph at the end of section.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.AddTable">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.InsertXHTML(System.String)">
|
|
<summary>
|
|
Inserts html at end of text body.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.InsertXHTML(System.String,System.Int32)">
|
|
<summary>
|
|
Inserts html begins from paragraph specified by paragraphIndex.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.InsertXHTML(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Inserts html beginning from paragraph specified by paragraphIndex,
|
|
and after paragraph item specified by paragraphItemIndex.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IBody.EnsureMinimum">
|
|
<summary>
|
|
If the text body has no paragraphs, creates and appends one Paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IDocument">
|
|
<summary>
|
|
Represents the MS Word Document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.BuiltinDocumentProperties">
|
|
<summary>
|
|
Gets document's built-in properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.CustomDocumentProperties">
|
|
<summary>
|
|
Gets document's custom properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Sections">
|
|
<summary>
|
|
Gets collection of sections of this document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Styles">
|
|
<summary>
|
|
Gets collection of styles.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.ListReferences">
|
|
<summary>
|
|
Gets collection of list styles.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Bookmarks">
|
|
<summary>
|
|
Gets collection of bookmarks of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.TextBoxes">
|
|
<summary>
|
|
Gets the textboxes of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.TOC">
|
|
<summary>
|
|
Gets or sets the TOC element of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Comments">
|
|
<summary>
|
|
Gets Collection of Comments of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.LastSection">
|
|
<summary>
|
|
Gets last section object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.LastParagraph">
|
|
<summary>
|
|
Gets the last paragraph.
|
|
</summary>
|
|
<value>The last paragraph.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.ProtectionType">
|
|
<summary>
|
|
Gets or sets the type of protection of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.ViewSetup">
|
|
<summary>
|
|
Returns or setsview type in MSWord.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Watermark">
|
|
<summary>
|
|
Gets or sets watermark for the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.MailMerge">
|
|
<summary>
|
|
Gets mail merge engine.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Background">
|
|
<summary>
|
|
Gets background for the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Variables">
|
|
<summary>
|
|
Gets or sets the document variables.
|
|
</summary>
|
|
<value>The variables.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.Properties">
|
|
<summary>
|
|
Gets the document properties.
|
|
</summary>
|
|
<value>The properties.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.HasChanges">
|
|
<summary>
|
|
Gets a value indicating whether the document has tracked changes.
|
|
</summary>
|
|
<value>
|
|
if the document has tracked changes, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocument.IsUpdateFields">
|
|
<summary>
|
|
Gets or sets a value indicating whether to update fields in the document.
|
|
On the moment only DOCVARIABLE fields can be updated.
|
|
</summary>
|
|
<value>if update fields, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.CreateMinialDocument">
|
|
<summary>
|
|
If the document contains no sections, creates one section
|
|
with one paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.AddSection">
|
|
<summary>
|
|
Adds new section to document.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.AddParagraphStyle(System.String)">
|
|
<summary>
|
|
Adds new paragraph style to document.
|
|
</summary>
|
|
<param name="styleName">Paragraph style name</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.AddListDefinitionReference(Spire.Doc.Documents.ListType,System.String)">
|
|
<summary>
|
|
Adds a reference to a list definition with the specified type and name.
|
|
</summary>
|
|
<param name="listType">The type of the list.</param>
|
|
<param name="listName">The name of the list.</param>
|
|
<returns>The created list definition reference.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.GetText">
|
|
<summary>
|
|
Gets the document's text.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToImages(Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Converts the whole document into images
|
|
</summary>
|
|
<param name="type">The ImageType</param>
|
|
<returns>Return the images</returns>
|
|
<remarks>Layouting of the pages is not exactly the same as the layouting made by Microsoft Word. The total number of pages and layouting of the elements may vary.</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToImages(System.Int32,System.Drawing.Imaging.ImageFormat)">
|
|
<summary>
|
|
Converts the specified page into image
|
|
</summary>
|
|
<param name="pageIndex">Zero based page index</param>
|
|
<param name="imageFormat">The ImageFormat</param>
|
|
<returns>Returns the image as stream</returns>
|
|
<remarks>Layouting of the pages is not exactly the same as the layouting made by MS-Word. The total number of pages and layouting of the elements may vary.</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToImages(System.Int32,Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Converts the specified page into image
|
|
</summary>
|
|
<param name="pageIndex">Zero based page index</param>
|
|
<param name="type"> The ImageType</param>
|
|
<returns>Returns the image</returns>
|
|
<remarks>Layouting of the pages is not exactly the same as the layouting made by MS-Word. The total number of pages and layouting of the elements may vary.</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToImages(System.Int32,System.Int32,Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Converts the specified range of pages into images
|
|
</summary>
|
|
<param name="pageIndex">Starting page index (Zero based)</param>
|
|
<param name="pageCount">Number of pages</param>
|
|
<param name="type">The ImageType</param>
|
|
<returns>Return the images</returns>
|
|
<remarks>Layouting of the pages is not exactly the same as the layouting made by MS-Word. The total number of pages and layouting of the elements may vary.</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.CreateParagraph">
|
|
<summary>
|
|
Creates the paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Clone">
|
|
<summary>
|
|
Make deep copy of word document.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.AddStyle(Spire.Doc.Documents.BuiltinStyle)">
|
|
<summary>
|
|
Adds the style to the document style.
|
|
</summary>
|
|
<param name="builtinStyle">The built-in style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Protect(Spire.Doc.ProtectionType)">
|
|
<summary>
|
|
Protects the document.
|
|
</summary>
|
|
<param name="type">The type of the protection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Protect(Spire.Doc.ProtectionType,System.String)">
|
|
<summary>
|
|
Protects the document.
|
|
</summary>
|
|
<param name="type">The type of the protection</param>
|
|
<param name="password">The password used for protection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Encrypt(System.String)">
|
|
<summary>
|
|
Encrypts the document.
|
|
</summary>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.RemoveEncryption">
|
|
<summary>
|
|
Removes the encryption.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.UpdateWordCount">
|
|
<summary>
|
|
Update Paragraphs count, Word count and Character count
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindPattern(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds and returns entry of specified regular expression along with formatting.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindString(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds and returns entry of specified string along with formatting,
|
|
taking into consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindPatternInLine(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the first entry of specified pattern in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindStringInLine(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the first entry of matchString text in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The string to find.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindAllPattern(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds and returns all entries of specified regular expression along with formatting.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindAllString(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds and returns all entries of specified string along with formatting,
|
|
taking into consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all occurrences of a character pattern specified
|
|
by a regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
<param name="newValue"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with newValue string, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="newValue"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with TextRangesHolder.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.Replace(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with TextSelection, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to search whole word, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ReplaceInLine(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString text with newValue text in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<param name="caseSensative">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies whole word to be newValue, set to <c>true</c>.</param>
|
|
<returns>The number of performed replaces.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ReplaceInLine(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries with specified pattern with newValue text in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<returns>The number of performed replaces.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ReplaceInLine(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces the matchString text with matchSelection in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="matchSelection">The matchSelection.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive newValue, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies whole word to be newValue, set to <c>true</c>.</param>
|
|
<returns>The number of performed replaces.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ReplaceInLine(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces the matchString pattern with matchSelection in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="matchSelection">The matchSelection.</param>
|
|
<returns>The number of performed replaces.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindString(Spire.Doc.BodyRegion,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the next entry of matchString string, taking into consideration caseSensitive
|
|
and wholeWord options.
|
|
</summary>
|
|
<param name="start">The text body item at which search starts (paragraph or table).</param>
|
|
<param name="matchString">The string to find.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive search, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies whole word to be search, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindPattern(Spire.Doc.BodyRegion,System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the next entry of matchString pattern.
|
|
</summary>
|
|
<param name="start">The start body item at which search starts (paragraph or table).</param>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindStringInLine(Spire.Doc.BodyRegion,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the next matchString text starting from specified.
|
|
BodyRegion using single-line mode.
|
|
</summary>
|
|
<param name="start">The start text body item.</param>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive search, set to <c>true</c> .</param>
|
|
<param name="wholeWord">if it specifies whole word to be search, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.FindPatternInLine(Spire.Doc.BodyRegion,System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the next text which fit the specified pattern starting from start BodyRegion
|
|
using single-line mode.
|
|
</summary>
|
|
<param name="start">The start body item.</param>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ResetFindState">
|
|
<summary>
|
|
Resets the FindPattern.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.LoadFromStream(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Opens the document from stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="formatType"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToFile(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Saves the document to a stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="formatType"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.LoadFromFile(System.String)">
|
|
<summary>
|
|
Opens the document from file in Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.LoadFromFile(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Opens the document from file in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName"></param>
|
|
<param name="formatType"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.LoadFromFileInReadMode(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
LoadFromStream new document in read-only mode.
|
|
</summary>
|
|
<param name="strFileName">File to open.</param>
|
|
<param name="formatType">Type of the format.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToFile(System.String)">
|
|
<summary>
|
|
Saves the document to file in Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.SaveToFile(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Saves the document to file in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
<param name="formatType">Type of the format</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ImportContent(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Imports all content into the document.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocument.ImportContent(Spire.Doc.Interface.IDocument,System.Boolean)">
|
|
<summary>
|
|
Imports all content into document.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="importStyles">If the document styles which have same names will be
|
|
also imported to the destination document, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IParagraph">
|
|
<summary>
|
|
Represents a paragraph inside a Section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.Text">
|
|
<summary>
|
|
Returns or sets paragraph text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="!:Spire.Doc.ParagraphBase"/> at the specified index.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.Items">
|
|
<summary>
|
|
Gets the paragraph items.
|
|
</summary>
|
|
<value>The items.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.Format">
|
|
<summary>
|
|
Gets the paragraph format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.ListFormat">
|
|
<summary>
|
|
Gets list formatting for the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.BreakCharacterFormat">
|
|
<summary>
|
|
Gets the character format for the break symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.IsInCell">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is in cell.
|
|
</summary>
|
|
<value>
|
|
if this paragraph is in cell, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.IsEndOfSection">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is end of section.
|
|
</summary>
|
|
<value>
|
|
if this paragraph is end of section, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraph.IsEndOfDocument">
|
|
<summary>
|
|
Gets a value indicating whether this paragraph is end of document.
|
|
</summary>
|
|
<value>
|
|
if this instance is end of document, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendText(System.String)">
|
|
<summary>
|
|
Appends text to the end of paragraph.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendPicture(System.Drawing.Image)">
|
|
<summary>
|
|
Appends picture to the end of paragraph.
|
|
</summary>
|
|
<param name="image">The image.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendPicture(System.Byte[])">
|
|
<summary>
|
|
Appends picture to the end of paragraph.
|
|
</summary>
|
|
<param name="imageBytes">The image bytes.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendField(System.String,Spire.Doc.FieldType)">
|
|
<summary>
|
|
Appends field to the end of paragraph
|
|
</summary>
|
|
<param name="fieldName">Name of the field.</param>
|
|
<param name="fieldType">Type of the field.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendBookmarkStart(System.String)">
|
|
<summary>
|
|
Appends start of the bookmark with specified name into paragraph.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendBookmarkEnd(System.String)">
|
|
<summary>
|
|
Appends end of the bookmark with specified name into paragraph.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendComment(System.String)">
|
|
<summary>
|
|
Appends the comment.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendFootnote(Spire.Doc.FootnoteType)">
|
|
<summary>
|
|
Appends the footnote.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendTextBox(System.Single,System.Single)">
|
|
<summary>
|
|
Appends textbox to the end of the paragraph
|
|
</summary>
|
|
<param name="width">Textbox width</param>
|
|
<param name="height">Textbox height</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendSymbol(System.Byte)">
|
|
<summary>
|
|
Appends symbol to the end of paragraph.
|
|
</summary>
|
|
<param name="characterCode">The character code.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendBreak(Spire.Doc.Documents.BreakType)">
|
|
<summary>
|
|
Appends break to end of paragraph.
|
|
</summary>
|
|
<param name="breakType">Type of the break.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendHTML(System.String)">
|
|
<summary>
|
|
Appends the HTML.
|
|
</summary>
|
|
<param name="html">The HTML.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.GetStyle">
|
|
<summary>
|
|
Gets related style.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.Replace(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with TextRangesHolder, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive search, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies the whole word to be newValue, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendCheckBox">
|
|
<summary>
|
|
Appends the check box.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendTextFormField(System.String)">
|
|
<summary>
|
|
Appends the text form field.
|
|
</summary>
|
|
<param name="defaultText">The default text.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendDropDownFormField">
|
|
<summary>
|
|
Appends the drop down form field.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendCheckBox(System.String,System.Boolean)">
|
|
<summary>
|
|
Appends the check box.
|
|
</summary>
|
|
<param name="checkBoxName">Name of the check box.</param>
|
|
<param name="defaultCheckBoxValue">Default checkbox value.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendTextFormField(System.String,System.String)">
|
|
<summary>
|
|
Appends the text form field.
|
|
</summary>
|
|
<param name="formFieldName">Name of the form field.</param>
|
|
<param name="defaultText">The default text.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendDropDownFormField(System.String)">
|
|
<summary>
|
|
Appends the drop down form field.
|
|
</summary>
|
|
<param name="dropDropDownName">Name of the drop drop down.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendHyperlink(System.String,System.String,Spire.Doc.Documents.HyperlinkType)">
|
|
<summary>
|
|
Appends the hyperlink.
|
|
</summary>
|
|
<param name="link">The link.</param>
|
|
<param name="text">The text to display.</param>
|
|
<param name="type">The hyperlink type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendHyperlink(System.String,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.HyperlinkType)">
|
|
<summary>
|
|
Appends the hyperlink.
|
|
</summary>
|
|
<param name="link">The link.</param>
|
|
<param name="picture">The picture to display.</param>
|
|
<param name="type">The type of hyperlink.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.RemoveAbsPosition">
|
|
<summary>
|
|
Removes the absolute position data. If paragraph has absolute position in the document,
|
|
all position data will be erased.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendTOC(System.Int32,System.Int32)">
|
|
<summary>
|
|
Appends the TOC.
|
|
</summary>
|
|
<param name="lowerHeadingLevel">The lower heading level.</param>
|
|
<param name="upperHeadingLevel">The upper heading level.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="oleStream">The OLE stream.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="oleBytes">The OLE bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.String,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleObjectType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="pathToFile">The path to file.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleObjectFileType">Type of the OLE object file.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.String,Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="pathToFile">The path to file.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleLinkType)">
|
|
<summary>
|
|
Appends the OLE object into paragraph.
|
|
</summary>
|
|
<param name="oleStorage">The OLE storage.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleLinkType">The type of OLE object link type.</param>
|
|
<param name="oleLinkType"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,Spire.Doc.Documents.OleLinkType)">
|
|
<summary>
|
|
Appends the OLE object.
|
|
</summary>
|
|
<param name="oleBytes">The OLE storage bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="oleLinkType">Type of the OLE link.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.Byte[],Spire.Doc.Fields.DocPicture,System.String)">
|
|
<summary>
|
|
Appends the package OLE object (ole object without specified type).
|
|
</summary>
|
|
<param name="oleBytes">The OLE object bytes.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="fileExtension">The file extension.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraph.AppendOleObject(System.IO.Stream,Spire.Doc.Fields.DocPicture,System.String)">
|
|
<summary>
|
|
Appends the package OLE object (ole object without specified type).
|
|
</summary>
|
|
<param name="oleStream">The OLE file stream.</param>
|
|
<param name="olePicture">The OLE picture.</param>
|
|
<param name="fileExtension">The file extension.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ISection">
|
|
<summary>
|
|
Represents a section inside a Document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.Paragraphs">
|
|
<summary>
|
|
Gets the paragraphs.
|
|
</summary>
|
|
<value>The paragraphs.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.Tables">
|
|
<summary>
|
|
Gets the tables.
|
|
</summary>
|
|
<value>The tables.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.Body">
|
|
<summary>
|
|
Gets the section body.
|
|
</summary>
|
|
<value>The body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.PageSetup">
|
|
<summary>
|
|
Gets page Setup of current section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.Columns">
|
|
<summary>
|
|
Get collection of columns which logically divide page on many
|
|
printing/publishing areas.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.BreakCode">
|
|
<summary>
|
|
Returns or setsbreak code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.ProtectForm">
|
|
<summary>
|
|
Gets or sets a value indicating whether [protect form].
|
|
</summary>
|
|
<value><c>true</c> if [protect form]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ISection.AddColumn(System.Single,System.Single)">
|
|
<summary>
|
|
Adds new column to the section.
|
|
</summary>
|
|
<param name="width"></param>
|
|
<param name="spacing"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ISection.AddParagraph">
|
|
<summary>
|
|
Adds the paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ISection.AddTable">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ISection.Clone">
|
|
<summary>
|
|
Clones it self.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ISection.MakeColumnsSameWidth">
|
|
<summary>
|
|
Makes all columns in current section to be of equal width.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ISection.HeadersFooters">
|
|
<summary>
|
|
Gets headers/footers of current section
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ITable">
|
|
<summary>
|
|
Represents a table in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.Rows">
|
|
<summary>
|
|
Gets row collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.TableFormat">
|
|
<summary>
|
|
Gets the table format.
|
|
</summary>
|
|
<value>The table format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.Format">
|
|
<summary>
|
|
Gets the table format.
|
|
</summary>
|
|
<value>The table format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.LastCell">
|
|
<summary>
|
|
Gets the last cell in last row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.FirstRow">
|
|
<summary>
|
|
Gets the last row in table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.LastRow">
|
|
<summary>
|
|
Gets the last row in table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.Item(System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets cell by row/column indexes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.Width">
|
|
<summary>
|
|
Returns or setstable width.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.AddRow">
|
|
<summary>
|
|
Adds new row to table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.AddRow(System.Boolean)">
|
|
<summary>
|
|
Adds new row to table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.AddRow(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Adds a row to table with copy format option
|
|
</summary>
|
|
<param name="isCopyFormat">Indicates whether copy format from previous row or not</param>
|
|
<param name="autoPopulateCells">if it specifies auto populate cells, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.ResetCells(System.Int32,System.Int32)">
|
|
<summary>
|
|
Resets rows / columns numbers.
|
|
</summary>
|
|
<param name="rowsNum">The rows number.</param>
|
|
<param name="columnsNum">The columns number.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.ResetCells(System.Int32,System.Int32,Spire.Doc.Formatting.RowFormat,System.Single)">
|
|
<summary>
|
|
Resets rows / columns numbers.
|
|
</summary>
|
|
<param name="rowsNum">The rows num.</param>
|
|
<param name="columnsNum">The columns num.</param>
|
|
<param name="format">The format.</param>
|
|
<param name="cellWidth">Width of the cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.ApplyVerticalMerge(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Applies the vertical merge for table cells.
|
|
</summary>
|
|
<param name="columnIndex">Index of the column.</param>
|
|
<param name="startRowIndex">Start index of the row.</param>
|
|
<param name="endRowIndex">End index of the row.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.ApplyHorizontalMerge(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Applies horizontal merging for cells of table row.
|
|
</summary>
|
|
<param name="rowIndex">Index of the row.</param>
|
|
<param name="startCellIndex">Start index of the cell.</param>
|
|
<param name="endCellIndex">End index of the cell.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITable.IndentFromLeft">
|
|
<summary>
|
|
Gets or sets indent from left for the table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITable.RemoveAbsPosition">
|
|
<summary>
|
|
Removes the absolute position data. If table has absolute position in the document,
|
|
all position data will be erased.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IParagraphBase">
|
|
<summary>
|
|
Interface publishes base paragraph item functionality
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraphBase.OwnerParagraph">
|
|
<summary>
|
|
Gets the owner paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IParagraphBase.ApplyStyle(System.String)">
|
|
<summary>
|
|
Applys the character style.
|
|
</summary>
|
|
<param name="styleName">the style name.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraphBase.StyleName">
|
|
<summary>
|
|
Gets the style name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IField">
|
|
<summary>
|
|
Interface publishes field functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IField.Type">
|
|
<summary>
|
|
Returns or sets field type
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IMergeField">
|
|
<summary>
|
|
Interface publishes merge field functionality
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IMergeField.FieldName">
|
|
<summary>
|
|
Returns or setsfield name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IMergeField.TextBefore">
|
|
<summary>
|
|
Gets or sets "text before" switching value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IMergeField.TextAfter">
|
|
<summary>
|
|
Gets or sets "text after" switching value
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IPicture">
|
|
<summary>
|
|
Represents a picture in a word document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.Height">
|
|
<summary>
|
|
Returns or setspicture height.
|
|
</summary>
|
|
<remarks>
|
|
The value is measured in points.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.Width">
|
|
<summary>
|
|
Returns or setspicture width.
|
|
</summary>
|
|
/// <remarks>
|
|
The value is measured in points.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.HeightScale">
|
|
<summary>
|
|
Returns or setspicture height scale factor in percent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.WidthScale">
|
|
<summary>
|
|
Returns or setspicture width scale factor in percent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IPicture.LoadImage(System.Drawing.Image)">
|
|
<summary>
|
|
Loads System.Drawing.Image object.
|
|
</summary>
|
|
<param name="image"></param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.Image">
|
|
<summary>
|
|
Gets internal System.Drawing.Image object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IPicture.LoadImage(System.Byte[])">
|
|
<summary>
|
|
Loads System.Drawing.Image as byte array.
|
|
</summary>
|
|
<param name="imageBytes"></param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.ImageBytes">
|
|
<summary>
|
|
Gets image byte array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IPicture.AddCaption(System.String,Spire.Doc.CaptionNumberingFormat,Spire.Doc.CaptionPosition)">
|
|
<summary>
|
|
Add Caption for current Picture
|
|
</summary>
|
|
<param name="captionPosition"></param>
|
|
<param name="name"></param>
|
|
<param name="format"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.HorizontalOrigin">
|
|
<summary>
|
|
Gets \ sets horizontal origin of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.VerticalOrigin">
|
|
<summary>
|
|
Gets \ sets vertical origin of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.HorizontalPosition">
|
|
<summary>
|
|
Gets \ sets absolute horizontal position of the picture.
|
|
</summary>
|
|
<remarks>
|
|
The value is measured in points and the position is relative to HorizontalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.VerticalPosition">
|
|
<summary>
|
|
Gets \ sets absolute vertical position of the picture.
|
|
</summary>
|
|
<remarks>
|
|
The value is measured in points and the position is relative to VerticalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.TextWrappingStyle">
|
|
<summary>
|
|
Gets \ sets text wrapping style of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.TextWrappingType">
|
|
<summary>
|
|
Gets \ sets text wrapping type of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.HorizontalAlignment">
|
|
<summary>
|
|
Returns or setspicture horizontal alignment.
|
|
</summary>
|
|
<remarks>
|
|
If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.VerticalAlignment">
|
|
<summary>
|
|
Returns or setspicture vertical alignment.
|
|
</summary>
|
|
<remarks>
|
|
If it is set as None, then the object is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to VerticalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.AlternativeText">
|
|
<summary>
|
|
Gets or sets the picture's alternative text.
|
|
</summary>
|
|
<value>The alternative text.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.Title">
|
|
<summary>
|
|
Gets or sets the picture's title
|
|
</summary>
|
|
<value>The title text</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IPicture.IsUnderText">
|
|
<summary>
|
|
Gets or sets a value indicating whether the picture is under text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ITextBox">
|
|
<summary>
|
|
Summary description for ITextBox.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITextBox.Body">
|
|
<summary>
|
|
Gets the text box body.
|
|
</summary>
|
|
<value>The text box body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITextBox.Format">
|
|
<summary>
|
|
Gets or sets the text box format.
|
|
</summary>
|
|
<value>The text box format.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.ITextRange">
|
|
<summary>
|
|
Interface publishes text range functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITextRange.Text">
|
|
<summary>
|
|
Returns or sets text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.ITextRange.CharacterFormat">
|
|
<summary>
|
|
Gets text format.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.ITextRange.ApplyCharacterFormat(Spire.Doc.Formatting.CharacterFormat)">
|
|
<summary>
|
|
Applies specified character format for current text range.
|
|
</summary>
|
|
<param name="charFormat"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IParagraphStyle">
|
|
<summary>
|
|
Represents the style that can be used to format a Paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraphStyle.ParagraphFormat">
|
|
<summary>
|
|
Gets formatting of paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IParagraphStyle.CharacterFormat">
|
|
<summary>
|
|
Gets formatting of characters inside paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IStyle">
|
|
<summary>
|
|
Publishes the DLS style base functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IStyle.Name">
|
|
<summary>
|
|
Gets the style name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IStyle.StyleId">
|
|
<summary>
|
|
Gets the style id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IStyle.StyleType">
|
|
<summary>
|
|
Gets the type of the style.
|
|
</summary>
|
|
<value>The type of the style.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyle.Clone">
|
|
<summary>
|
|
Clones itself.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IStyleHolder">
|
|
<summary>
|
|
Interface publishes base functionality for style holders
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IStyleHolder.StyleName">
|
|
<summary>
|
|
Gets style name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyleHolder.ApplyStyle(System.String)">
|
|
<summary>
|
|
Applies a new style.
|
|
</summary>
|
|
<param name="styleName"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IStyleHolder.ApplyStyle(Spire.Doc.Documents.BuiltinStyle)">
|
|
<summary>
|
|
Applies the style.
|
|
</summary>
|
|
<param name="builtinStyle">The built-in style.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSAttributeWriter">
|
|
<summary>
|
|
Summary description for IXDLSAttributeWriter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Single)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Double)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Int32)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.String)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Enum)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Boolean)">
|
|
<summary>
|
|
Writes the value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">if it specifies value, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.Drawing.Color)">
|
|
<summary>
|
|
Writes color as string to XML.
|
|
</summary>
|
|
<param name="name">Name of attribute.</param>
|
|
<param name="value">Color structure.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeWriter.WriteValue(System.String,System.DateTime)">
|
|
<summary>
|
|
Writes DateTime as string to XML.
|
|
</summary>
|
|
<param name="name">Name of attribute.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSAttributeReader">
|
|
<summary>
|
|
Summary description for IXDLSAttributeReader.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.HasAttribute(System.String)">
|
|
<summary>
|
|
Determines whether the current node has attribute with specified name.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns>
|
|
if has attribute with specified name, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadString(System.String)">
|
|
<summary>
|
|
Reads the string.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadInt(System.String)">
|
|
<summary>
|
|
Reads the int.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadShort(System.String)">
|
|
<summary>
|
|
Reads the short.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadFloat(System.String)">
|
|
<summary>
|
|
Reads the float.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadDouble(System.String)">
|
|
<summary>
|
|
Reads the double.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadBoolean(System.String)">
|
|
<summary>
|
|
Reads the boolean.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadByte(System.String)">
|
|
<summary>
|
|
Reads the byte.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadEnum(System.String,System.Type)">
|
|
<summary>
|
|
Reads the enum.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="enumType">Type of the enum.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadColor(System.String)">
|
|
<summary>
|
|
Reads color from XML.
|
|
</summary>
|
|
<param name="name">Name of attribute.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSAttributeReader.ReadDateTime(System.String)">
|
|
<summary>
|
|
Reads the date time.
|
|
</summary>
|
|
<param name="s">The s.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSContentWriter">
|
|
<summary>
|
|
Summary description for IXDLSContentWriter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentWriter.WriteChildBinaryElement(System.String,System.Byte[])">
|
|
<summary>
|
|
Writes the child binary element.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentWriter.WriteChildStringElement(System.String,System.String)">
|
|
<summary>
|
|
Writes the child string element.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentWriter.WriteChildElement(System.String,System.Object)">
|
|
<summary>
|
|
Writes the child element.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentWriter.WriteChildRefElement(System.String,System.Int32)">
|
|
<summary>
|
|
Writes the child ref element.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSContentWriter.InnerWriter">
|
|
<summary>
|
|
Gets the inner writer.
|
|
</summary>
|
|
<value>The inner writer.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSContentReader">
|
|
<summary>
|
|
Summary description for IXDLSContentReader.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSContentReader.TagName">
|
|
<summary>
|
|
Gets the name of the tag.
|
|
</summary>
|
|
<value>The name of the tag.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSContentReader.NodeType">
|
|
<summary>
|
|
Gets the type of the node.
|
|
</summary>
|
|
<value>The type of the node.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.GetAttributeValue(System.String)">
|
|
<summary>
|
|
Gets the attribute value.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.ParseElementType(System.Type,System.Enum@)">
|
|
<summary>
|
|
Parses the type of the element.
|
|
</summary>
|
|
<param name="enumType">Type of the enum.</param>
|
|
<param name="elementType">Type of the element.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.ReadChildElement(System.Object)">
|
|
<summary>
|
|
Reads the child element.
|
|
</summary>
|
|
<param name="value">The value.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.ReadChildElement(System.Type)">
|
|
<summary>
|
|
Reads the child element.
|
|
</summary>
|
|
<param name="type">The type.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.ReadChildStringContent">
|
|
<summary>
|
|
Reads the content of the child string.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSContentReader.ReadChildBinaryElement">
|
|
<summary>
|
|
Reads the child binary element.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSContentReader.InnerReader">
|
|
<summary>
|
|
Gets the inner reader.
|
|
</summary>
|
|
<value>The inner reader.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSContentReader.AttributeReader">
|
|
<summary>
|
|
Gets the attribute reader.
|
|
</summary>
|
|
<value>The attribute reader.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IDocumentSerializable">
|
|
<summary>
|
|
Represents required functionality for serialization by XDLSReader/Writer.
|
|
<remarks>Used for objects/items implementation</remarks>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentSerializable.WriteXmlAttributes(Spire.Doc.Interface.IXDLSAttributeWriter)">
|
|
<summary>
|
|
Object can writes by this method own "value" properties
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentSerializable.WriteXmlContent(Spire.Doc.Interface.IXDLSContentWriter)">
|
|
<summary>
|
|
Object can writes by this method own complex/binary data.
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentSerializable.ReadXmlAttributes(Spire.Doc.Interface.IXDLSAttributeReader)">
|
|
<summary>
|
|
Object can reads by this method own "value" properties
|
|
</summary>
|
|
<param name="reader"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentSerializable.ReadXmlContent(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Object can reads by this method own complex/binary data.
|
|
</summary>
|
|
<param name="reader"></param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IDocumentSerializable.XDLSHolder">
|
|
<summary>
|
|
Gets special holder with child objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IDocumentSerializable.RestoreReference(System.String,System.Int32)">
|
|
<summary>
|
|
Object can use this method for restore references.
|
|
</summary>
|
|
<param name="name"></param>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSSerializableCollection">
|
|
<summary>
|
|
Represents required functionality for serialization by XDLSReader/Writer.
|
|
<remarks>Used for collections/lists implementation</remarks>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSSerializableCollection.AddNewItem(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Collection must creates and adds new empty item.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSSerializableCollection.CreateNewItem(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Creates a new item using the provided XDLS content reader.
|
|
</summary>
|
|
<param name="reader">The XDLS content reader.</param>
|
|
<returns>The newly created item.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSSerializableCollection.AddItem(Spire.Doc.Interface.IDocumentSerializable)">
|
|
<summary>
|
|
Adds an item to the collection.
|
|
</summary>
|
|
<param name="item">The item to add.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSSerializableCollection.TagItemName">
|
|
<summary>
|
|
Gets the name of the tag item.
|
|
</summary>
|
|
<value>The name of the tag item.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Interface.IXDLSSerializableCollection.Count">
|
|
<summary>
|
|
Gets the count.
|
|
</summary>
|
|
<value>The count.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Interface.IXDLSFactory">
|
|
<summary>
|
|
Summary description for IXDLSFactory.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Interface.IXDLSFactory.Create(Spire.Doc.Interface.IXDLSContentReader)">
|
|
<summary>
|
|
Creates the specified reader.
|
|
</summary>
|
|
<param name="reader">The reader.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.License.LicenseProvider">
|
|
<summary>
|
|
Class Spire.Doc.LicenseProvider.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetLicense(System.String)">
|
|
<summary>
|
|
Provides a license by a license file path, which will be used for loading license.
|
|
</summary>
|
|
<param name="licenseFileFullPath">License file full path.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetLicense(System.IO.Stream)">
|
|
<summary>
|
|
Provides a license by a license stream, which will be used for loading license.
|
|
</summary>
|
|
<param name="licenseFileStream">License data stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetLicenseKey(System.String)">
|
|
<summary>
|
|
Provides a license by a license key, which will be used for loading license.
|
|
</summary>
|
|
<param name="key">The value of the Key attribute of the element License of you license xml file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetLicenseKey(System.String,System.Boolean)">
|
|
<summary>
|
|
Sets the license key required for license loading, and specifies whether to use a development or test license.
|
|
</summary>
|
|
<param name="key">The value of the Key attribute of the element License of you license xml file.</param>
|
|
<param name="useDevOrTestLicense">Indicates whether to apply a development or test license.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.UnbindDevelopmentOrTestingLicenses">
|
|
<summary>
|
|
Unbind development or testing licenses.
|
|
Only development or testing licenses can be unbound, deployment licenses cannot be unbound.
|
|
The approach to lifting development or testing licenses does not allow frequent invocation by the same machine code,
|
|
mandating a two-hour wait period before it can be invoked again.
|
|
</summary>
|
|
<returns>Returns true if the unbinding operation was successful; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetLicenseFileName(System.String)">
|
|
<summary>
|
|
Sets the license file name, which will be used for loading license.
|
|
</summary>
|
|
<param name="licenseFileName">License file name.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.ClearLicense">
|
|
<summary>
|
|
Clear all cached license.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.LoadLicense">
|
|
<summary>
|
|
Load the license provided by current setting to the license cache.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.License.LicenseProvider.SetAppKey(System.String)">
|
|
<summary>
|
|
Provides app key, which will be used for AI Calling.
|
|
</summary>
|
|
<param name="appKey">app key.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisBound">
|
|
<summary>
|
|
Represents a class that defines the bound value for an <see cref="T:Spire.Doc.Fields.Shapes.Charts.AxisBounds"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisBound.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the AxisBound class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisBound.#ctor(System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the AxisBound class with the specified value.
|
|
</summary>
|
|
<param name="value">The value to initialize the AxisBound with.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisBound.#ctor(System.DateTime)">
|
|
<summary>
|
|
Initializes a new instance of the AxisBound class with a DateTime value.
|
|
</summary>
|
|
<param name="datetime">The DateTime value to initialize the AxisBound with.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBound.IsAuto">
|
|
<summary>
|
|
Gets a value indicating whether the property is automatically managed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBound.Value">
|
|
<summary>
|
|
Gets the value.
|
|
</summary>
|
|
<value>
|
|
The value.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBound.ValueAsDate">
|
|
<summary>
|
|
Converts the stored OLE Automation date to a DateTime value.
|
|
</summary>
|
|
<returns>
|
|
A DateTime value representing the OLE Automation date.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisCategoryType">
|
|
<summary>
|
|
Specifies type of a category axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCategoryType.Automatic">
|
|
<summary>
|
|
Specifies that type of a category axis is determined automatically based on data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCategoryType.Category">
|
|
<summary>
|
|
Specifies an axis of an arbitrary set of categories.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCategoryType.Time">
|
|
<summary>
|
|
Specifies a time category axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisDisplayUnits">
|
|
<summary>
|
|
Represents the display units for an axis in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisDisplayUnits.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the AxisDisplayUnits class.
|
|
</summary>
|
|
<param name="axis">The chart axis to which the display units are associated.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisDisplayUnits.Unit">
|
|
<summary>
|
|
Gets or sets the built-in unit of the axis display.
|
|
</summary>
|
|
<returns>
|
|
The built-in unit of the axis display.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisDisplayUnits.CustomUnit">
|
|
<summary>
|
|
Gets or sets the custom unit for the axis display units.
|
|
</summary>
|
|
<returns>The custom unit value.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisDisplayUnits.ShowLabel">
|
|
<summary>
|
|
Gets or sets whether show display units label on the chart.
|
|
</summary>
|
|
<returns>
|
|
true if the display units label is shown; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisScaleType">
|
|
<summary>
|
|
Specifies the possible scale types for an axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisScaleType.Linear">
|
|
<summary>
|
|
Linear scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisScaleType.Logarithmic">
|
|
<summary>
|
|
Logarithmic scaling.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit">
|
|
<summary>
|
|
Specifies the display units for an axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.None">
|
|
<summary>
|
|
Specifies the values on the chart shall displayed as is.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Custom">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by a user-defined divisor. This value is not supported
|
|
by the new chart types of MS Office 2016.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Billions">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 1,000,000,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.HundredMillions">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 100,000,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Hundreds">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 100.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.HundredThousands">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 100,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Millions">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 1,000,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.TenMillions">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 10,000,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.TenThousands">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 10,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Thousands">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 1,000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Trillions">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 1,000,000,000,0000.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisBuiltInUnit.Percentage">
|
|
<summary>
|
|
Specifies the values on the chart shall be divided by 0.01. This value is supported only by the new chart
|
|
types of MS Office 2016.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisBounds">
|
|
<summary>
|
|
Represents the bounds of an axis in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisBounds.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the AxisBounds class with the specified chart axis.
|
|
</summary>
|
|
<param name="axis">The chart axis to associate with the AxisBounds.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBounds.Minimum">
|
|
<summary>
|
|
Gets or sets the minimum value of the axis.
|
|
</summary>
|
|
<value>
|
|
The minimum value of the axis.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBounds.Maximum">
|
|
<summary>
|
|
Gets or sets the maximum value of the axis.
|
|
</summary>
|
|
<returns>
|
|
The maximum value of the axis.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisBounds.LogBase">
|
|
<summary>
|
|
Gets or sets the logarithmic scale base.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels">
|
|
<summary>
|
|
Represents a class to handle the options of axis tick labels in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the AxisTickLabels class.
|
|
</summary>
|
|
<param name="axis">The chart axis to which the tick labels belong.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.Spacing">
|
|
<summary>
|
|
Gets or sets the interval unit between labels on the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.IsAutoSpacing">
|
|
<summary>
|
|
Gets or sets a value indicating whether the interval between labels is automatically determined.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the interval is automatically determined; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.Offset">
|
|
<summary>
|
|
Gets or sets the distance from axis of the labels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.Position">
|
|
<summary>
|
|
Gets or sets the position of the labels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickLabels.Alignment">
|
|
<summary>
|
|
Gets or sets the alignment of the labels.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisTickMarks">
|
|
<summary>
|
|
Represents a class to handle the options of axis tick marks in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisTickMarks.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the AxisTickMarks class.
|
|
</summary>
|
|
<param name="axis">The chart axis to which the tick marks belong.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickMarks.Spacing">
|
|
<summary>
|
|
Gets or sets the interval between tick marks on the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickMarks.Major">
|
|
<summary>
|
|
Gets or sets the major type of the tick marks for the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisTickMarks.Minor">
|
|
<summary>
|
|
Gets or sets the minor type of the tick marks for the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisUnits">
|
|
<summary>
|
|
Represents the units for an axis in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.AxisUnits.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the AxisUnits class.
|
|
</summary>
|
|
<param name="axis">The chart axis to associate with the units.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.Major">
|
|
<summary>
|
|
Gets or sets the major unit value of the axis.
|
|
</summary>
|
|
<value>
|
|
The major unit value.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.MajorTimeUnit">
|
|
<summary>
|
|
Gets or sets the major time unit for the date axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.IsMajorAuto">
|
|
<summary>
|
|
Gets or sets a value indicating whether the major units on the axis are automatically determined.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the major units are automatically determined; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.Minor">
|
|
<summary>
|
|
Gets or sets the minor unit value of the axis.
|
|
</summary>
|
|
<value>The minor unit value.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.MinorTimeUnit">
|
|
<summary>
|
|
Gets or sets the minor time unit of the date axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.IsMinorAuto">
|
|
<summary>
|
|
Gets or sets a value indicating whether the minor units on the axis are automatically determined.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the minor units are automatically determined; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.AxisUnits.BaseTimeUnit">
|
|
<summary>
|
|
Gets or sets the base time unit of the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle">
|
|
<summary>
|
|
Represents the title of an axis in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle.#ctor(Spire.Doc.Fields.Shapes.Charts.ChartAxis)">
|
|
<summary>
|
|
Initializes a new instance of the ChartAxisTitle class.
|
|
</summary>
|
|
<param name="axis">The ChartAxis to which the title is associated.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle.Show">
|
|
<summary>
|
|
Gets or sets a value indicating whether the title is visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle.Text">
|
|
<summary>
|
|
Gets or sets the text of the axis title.
|
|
</summary>
|
|
<value>The text of the axis title.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle.Overlay">
|
|
<summary>
|
|
Gets or sets a value indicating whether the title is overlaid on the chart.
|
|
</summary>
|
|
<returns>
|
|
true if the title is overlaid; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle.GetCharacterFormat">
|
|
<summary>
|
|
Gets the font format used for the axis title.
|
|
</summary>
|
|
<returns>The font of the axis title.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartDataTable">
|
|
<summary>
|
|
Represents a data table options associated with a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.#ctor(Spire.Doc.Fields.Shapes.Charts.Core.DmlChartPlotArea)">
|
|
<summary>
|
|
Initializes a new instance of the ChartDataTable class.
|
|
</summary>
|
|
<param name="chart">The chart associated with the data table.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.Show">
|
|
<summary>
|
|
Gets or sets a value indicating whether the DataTable is visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.ShowLegendKeys">
|
|
<summary>
|
|
Gets or sets a value indicating whether to show legend keys.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.ShowHorizontalBorder">
|
|
<summary>
|
|
Gets or sets a value indicating whether the horizontal border of the data table is shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.ShowVerticalBorder">
|
|
<summary>
|
|
Gets or sets a value indicating whether the vertical border of the data table is shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.ShowOutlineBorder">
|
|
<summary>
|
|
Gets or sets a value indicating whether the outline border of the data table is shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataTable.CharacterFormat">
|
|
<summary>
|
|
Gets the font format for the text properties.
|
|
</summary>
|
|
<returns>The FontFormat object representing the font properties.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.Chart">
|
|
<summary>
|
|
Provides access to the chart shape properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.Series">
|
|
<summary>
|
|
Provides access to series collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.Title">
|
|
<summary>
|
|
Provides access to the chart title properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.Legend">
|
|
<summary>
|
|
Provides access to the chart legend properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.AxisX">
|
|
<summary>
|
|
Provides access to properties of the X axis of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.AxisY">
|
|
<summary>
|
|
Provides access to properties of the Y axis of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.AxisZ">
|
|
<summary>
|
|
Provides access to properties of the Z axis of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.Axes">
|
|
<summary>
|
|
Gets the collection of axes for the chart.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:Spire.Doc.Fields.Shapes.Charts.ChartAxisCollection"/> containing the axes of the chart.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.Chart.DataTable">
|
|
<summary>
|
|
Gets the Data Table Options associated with the Chart.
|
|
</summary>
|
|
<returns>A ChartDataTable object representing the data table for the chart.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.Chart.ChangeSeriesType(System.String,Spire.Doc.Fields.Shapes.Charts.ChartSeriesType,System.Boolean)">
|
|
<summary>
|
|
Choose the chart type and axis for the data series.
|
|
This method is intended for manipulating combo chart.
|
|
</summary>
|
|
<param name="seriesName">The series name.</param>
|
|
<param name="seriesType">The chart type for this series.</param>
|
|
<param name="showOnSecondaryAxis">Show this series on the secondary axis.</param>
|
|
<exception cref="T:System.InvalidOperationException"></exception>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.Chart.mSeriesCollection">
|
|
<summary>
|
|
Create a simple chart for the combo charts.
|
|
</summary>
|
|
<param name="paragraph">The paragraph where chart located.</param>
|
|
<param name="chartType">The chart type to insert into the document.</param>
|
|
<param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
|
|
<returns>The simple chart with one series.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartAxis">
|
|
<summary>
|
|
Represents a chart axis in a chart.
|
|
Implements interfaces for handling chart titles, extension lists, and number format providers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Type">
|
|
<summary>
|
|
Gets the type of the chart axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.CategoryType">
|
|
<summary>
|
|
Gets or sets the type of the category axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Bounds">
|
|
<summary>
|
|
Gets the bounds for the axis.
|
|
</summary>
|
|
<returns>The bounds of the axis.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Units">
|
|
<summary>
|
|
Gets the units for the axis.
|
|
</summary>
|
|
<returns>The units of the axis.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Crosses">
|
|
<summary>
|
|
Gets of sets the axis crosses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.CrossesAt">
|
|
<summary>
|
|
Gets or sets the axis crosses value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.AxisBetweenCategories">
|
|
<summary>
|
|
Gets or sets a value indicating whether the axis is between tick marks.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the axis is between tick marks; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
This property is applicable only when the axis type is either Category or Date.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.DisplayUnits">
|
|
<summary>
|
|
Gets the display units for the axis.
|
|
</summary>
|
|
<returns>The display units for the axis.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.ReverseOrder">
|
|
<summary>
|
|
Gets or sets a value indicating whether the categories in reverse order.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.TickMarks">
|
|
<summary>
|
|
Gets the tick marks options for the axis.
|
|
</summary>
|
|
<returns>The tick marks options for the axis.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Labels">
|
|
<summary>
|
|
Gets the tick labels options for the axis.
|
|
</summary>
|
|
<returns>
|
|
The tick labels options for the axis.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.NumberFormat">
|
|
<summary>
|
|
Gets the number format for the axis.
|
|
</summary>
|
|
<returns>The <see cref="T:Spire.Doc.Fields.Shapes.Charts.ChartNumberFormat"/> object representing the number format.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.HasMajorGridlines">
|
|
<summary>
|
|
Gets or sets a value indicating whether major gridlines are enabled.
|
|
</summary>
|
|
<returns>
|
|
true if major gridlines are enabled; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.HasMinorGridlines">
|
|
<summary>
|
|
Gets or sets a value indicating whether minor gridlines are enabled.
|
|
</summary>
|
|
<returns>
|
|
true if minor gridlines are enabled; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Delete">
|
|
<summary>
|
|
Gets or sets a value indicating whether the chart axis is hidden.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the chart axis is hidden; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.Title">
|
|
<summary>
|
|
Gets the title of the chart axis.
|
|
</summary>
|
|
<returns>The <see cref="T:Spire.Doc.Fields.Shapes.Charts.ChartAxisTitle"/> object representing the title of the chart axis.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartAxis.TextVerticalType">
|
|
<summary>
|
|
Sets the vetrtical type for the axis text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartAxisType">
|
|
<summary>
|
|
Specifies the type for an axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartAxisType.Category">
|
|
<summary>
|
|
Category axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartAxisType.Date">
|
|
<summary>
|
|
Date axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartAxisType.Series">
|
|
<summary>
|
|
Series axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartAxisType.Value">
|
|
<summary>
|
|
Value axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel">
|
|
<summary>
|
|
Represents a data label for chart elements.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.Index">
|
|
<summary>
|
|
Gets or sets the index of the item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowCategoryName">
|
|
<summary>
|
|
Gets or sets a value indicating whether the category name should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowBubbleSize">
|
|
<summary>
|
|
Gets or sets a value indicating whether the size of the bubbles should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowLegendKey">
|
|
<summary>
|
|
Gets or sets a value indicating whether the legend key should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowPercentage">
|
|
<summary>
|
|
Gets or sets a value indicating whether to display the percentage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowSeriesName">
|
|
<summary>
|
|
Gets or sets a value indicating whether the series name should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowValue">
|
|
<summary>
|
|
Gets or sets a value indicating whether the value should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowLeaderLines">
|
|
<summary>
|
|
Gets or sets a value indicating whether leader lines are displayed for the data labels.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.ShowDataLabelsRange">
|
|
<summary>
|
|
Gets or sets a value indicating whether data labels should be displayed for a specified range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.Separator">
|
|
<summary>
|
|
Gets or sets the separator used to distinguish between different elements in a string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.IsVisible">
|
|
<summary>
|
|
Gets or sets a value indicating whether the element is visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.NumberFormat">
|
|
<summary>
|
|
Gets or sets the number format for the chart values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabel.CharacterFormat">
|
|
<summary>
|
|
Gets the font format for the current data label.
|
|
</summary>
|
|
<returns>The FontFormat instance for the text properties.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection">
|
|
<summary>
|
|
Represent the data labels options for the chart series.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the ChartDataLabel at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the ChartDataLabel to get.</param>
|
|
<returns>The ChartDataLabel at the specified index.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.Count">
|
|
<summary>
|
|
Gets the number of data labels in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.ShowCategoryName">
|
|
<summary>
|
|
Gets or sets a value indicating whether the label contains the category name.
|
|
</summary>
|
|
<value>
|
|
true if the label contains the category name; otherwise, false.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.ShowLegendKey">
|
|
<summary>
|
|
Gets or sets a value indicating whether the label contains the legend key.
|
|
</summary>
|
|
<value>
|
|
true if the label contains the legend key; otherwise, false.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.ShowSeriesName">
|
|
<summary>
|
|
Gets or sets a value indicating whether the label contains the series name.
|
|
</summary>
|
|
<value>
|
|
true if the label contains the series name; otherwise, false.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.ShowValue">
|
|
<summary>
|
|
Gets or sets a value indicating whether the label contains the value.
|
|
</summary>
|
|
<value>
|
|
true if the label contains the value; otherwise, false.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.ShowLeaderLines">
|
|
<summary>
|
|
Gets or sets a value indicating whether leader lines are shown for the label.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if leader lines are shown; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.Separator">
|
|
<summary>
|
|
Gets or sets the separator used in the labels.
|
|
</summary>
|
|
<returns>The separator string.</returns>
|
|
<param name="value">The separator string to set.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.NumberFormat">
|
|
<summary>
|
|
Gets the number format for the label.
|
|
</summary>
|
|
<returns>The ChartNumberFormat object that represents the number format for the label.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataLabelCollection.CharacterFormat">
|
|
<summary>
|
|
Gets the font format for the data labels.
|
|
</summary>
|
|
<returns>The FontFormat object representing the font properties.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint">
|
|
<summary>
|
|
Represents a data point for a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint.Index">
|
|
<summary>
|
|
Gets or sets the index of the item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint.Explosion">
|
|
<summary>
|
|
Represents the level or intensity of an explosion.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint.InvertIfNegative">
|
|
<summary>
|
|
Gets or sets a value indicating whether the value should be inverted if it is negative.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint.Bubble3D">
|
|
<summary>
|
|
Gets or sets a value indicating whether the 3D chart should display a bubble effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPoint.Marker">
|
|
<summary>
|
|
Represents the marker used for data points in a chart series.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection">
|
|
<summary>
|
|
Represents a collection of ChartDataPoint objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the ChartDataPoint at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the ChartDataPoint to get or set.</param>
|
|
<returns>The ChartDataPoint at the specified index.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.Add(System.Int32)">
|
|
<summary>
|
|
Adds a new ChartDataPoint at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index at which the new ChartDataPoint should be inserted.</param>
|
|
<returns>The newly added ChartDataPoint.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the element at the specified index from the list.
|
|
</summary>
|
|
<param name="index">The zero-based index of the element to remove.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.Clear">
|
|
<summary>
|
|
Clears all items from the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartDataPointCollection.Count">
|
|
<summary>
|
|
Gets the number of items in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartLegend">
|
|
<summary>
|
|
Represents a chart legend in a DML (Drawing Markup Language) document.
|
|
Implements the IDmlExtensionListSource interface to provide a list of extensions for the legend.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartLegend.Show">
|
|
<summary>
|
|
Gets or sets a value indicating whether the legend is visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartLegend.Position">
|
|
<summary>
|
|
Gets or sets the position of the legend.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartLegend.Overlay">
|
|
<summary>
|
|
Gets or sets a value indicating whether show the legend with overlapping the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartLegend.CharacterFormat">
|
|
<summary>
|
|
Gets the font format for the text properties.
|
|
</summary>
|
|
<returns>The font format.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartMarker">
|
|
<summary>
|
|
Represents a chart data marker.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartMarker.Symbol">
|
|
<summary>
|
|
Gets or sets chart marker symbol.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartMarker.Size">
|
|
<summary>
|
|
Gets or sets chart marker size.
|
|
Default value is 7.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartNumberFormat">
|
|
<summary>
|
|
Represents a class for formatting numbers in charts.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartNumberFormat.FormatCode">
|
|
<summary>
|
|
Gets or sets the format code used for formatting the output.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartNumberFormat.IsLinkedToSource">
|
|
<summary>
|
|
Gets a value indicating whether the current instance is linked to its data source.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartSeries">
|
|
<summary>
|
|
Represents a series of data points for a chart, implementing interfaces for chart data point and DML extension list source.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.Explosion">
|
|
<summary>
|
|
Represents the intensity or magnitude of an explosion.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.InvertIfNegative">
|
|
<summary>
|
|
Gets or sets a value indicating whether the value should be inverted if it is negative.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.Marker">
|
|
<summary>
|
|
Represents the marker used in the chart to highlight data points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.Bubble3D">
|
|
<summary>
|
|
Gets or sets a value indicating whether the 3D bubble effect is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.ChartType">
|
|
<summary>
|
|
Gets the chart type of this series.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.DataPoints">
|
|
<summary>
|
|
Represents a collection of data points used in a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.Name">
|
|
<summary>
|
|
Gets or sets the name of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.Smooth">
|
|
<summary>
|
|
Gets or sets a value indicating whether the transition or movement should be smooth.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.HasDataLabels">
|
|
<summary>
|
|
Gets or sets whether data labels are enabled for the chart series.
|
|
</summary>
|
|
<returns>
|
|
True if data labels are enabled, otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeries.DataLabels">
|
|
<summary>
|
|
Represents a collection of data labels for a chart series.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection">
|
|
<summary>
|
|
Represents a collection of chart series.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the chart series at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the chart series to get.</param>
|
|
<returns>The chart series at the specified index.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>An enumerator that iterates through the collection.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the element at the specified index from the list.
|
|
</summary>
|
|
<param name="index">The zero-based index of the element to remove.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Clear">
|
|
<summary>
|
|
Clears all items from the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Add(System.String,System.String[],System.Double[])">
|
|
<summary>
|
|
Adds new ChartSeries to this collection.
|
|
Use this method to add series to any type of Bar, Column, Line and Surface charts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Add(System.String,System.Double[],System.Double[])">
|
|
<summary>
|
|
Adds new ChartSeries to this collection.
|
|
Use this method to add series to any type of Scatter charts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Add(System.String,System.DateTime[],System.Double[])">
|
|
<summary>
|
|
Adds new ChartSeries to this collection.
|
|
Use this method to add series to any type of Area, Radar and Stock charts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Add(System.String,System.Double[],System.Double[],System.Double[])">
|
|
<summary>
|
|
Adds new ChartSeries to this collection.
|
|
Use this method to add series to any type of Bubble charts.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartSeriesCollection.Count">
|
|
<summary>
|
|
Gets the number of elements in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartTitle">
|
|
<summary>
|
|
Represents a chart title in a document.
|
|
Implements the IDmlExtensionListSource interface to provide extension list functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartTitle.Text">
|
|
<summary>
|
|
Gets or sets the text content of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartTitle.Overlay">
|
|
<summary>
|
|
Gets or sets a value indicating whether the overlay should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartTitle.Show">
|
|
<summary>
|
|
Gets or sets a value indicating whether the element should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Charts.ChartTitle.CharacterFormat">
|
|
<summary>
|
|
Gets the font formatting for the title.
|
|
</summary>
|
|
<returns>The font formatting.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartType">
|
|
<summary>
|
|
Specifies type of a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Area">
|
|
<summary>
|
|
Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.AreaStacked">
|
|
<summary>
|
|
Stacked Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.AreaPercentStacked">
|
|
<summary>
|
|
100% Stacked Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Area3D">
|
|
<summary>
|
|
3D Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Area3DStacked">
|
|
<summary>
|
|
3D Stacked Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Area3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bar">
|
|
<summary>
|
|
Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.BarStacked">
|
|
<summary>
|
|
Stacked Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.BarPercentStacked">
|
|
<summary>
|
|
100% Stacked Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bar3D">
|
|
<summary>
|
|
3D Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bar3DStacked">
|
|
<summary>
|
|
3D Stacked Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bar3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bubble">
|
|
<summary>
|
|
Bubble chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Bubble3D">
|
|
<summary>
|
|
3D Bubble chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Column">
|
|
<summary>
|
|
Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.ColumnStacked">
|
|
<summary>
|
|
Stacked Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.ColumnPercentStacked">
|
|
<summary>
|
|
100% Stacked Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Column3D">
|
|
<summary>
|
|
3D Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Column3DStacked">
|
|
<summary>
|
|
3D Stacked Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Column3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Column3DClustered">
|
|
<summary>
|
|
3D Clustered Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Doughnut">
|
|
<summary>
|
|
Doughnut chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Line">
|
|
<summary>
|
|
Line chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.LineStacked">
|
|
<summary>
|
|
Stacked Line chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.LinePercentStacked">
|
|
<summary>
|
|
100% Stacked Line chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Line3D">
|
|
<summary>
|
|
3D Line chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Pie">
|
|
<summary>
|
|
Pie chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Pie3D">
|
|
<summary>
|
|
3D Pie chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.PieOfBar">
|
|
<summary>
|
|
Pie of Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.PieOfPie">
|
|
<summary>
|
|
Pie of Pie chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Radar">
|
|
<summary>
|
|
Radar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Scatter">
|
|
<summary>
|
|
Scatter chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Stock">
|
|
<summary>
|
|
Stock chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Surface">
|
|
<summary>
|
|
Surface chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartType.Surface3D">
|
|
<summary>
|
|
3D Surface chart.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType">
|
|
<summary>
|
|
Specifies type of a series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Area">
|
|
<summary>
|
|
Area series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.AreaStacked">
|
|
<summary>
|
|
Stacked Area series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.AreaPercentStacked">
|
|
<summary>
|
|
100% Stacked Area series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Area3D">
|
|
<summary>
|
|
3D Area chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Area3DStacked">
|
|
<summary>
|
|
3D Stacked Area series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Area3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Area series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bar">
|
|
<summary>
|
|
Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.BarStacked">
|
|
<summary>
|
|
Stacked Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.BarPercentStacked">
|
|
<summary>
|
|
100% Stacked Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bar3D">
|
|
<summary>
|
|
3D Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bar3DStacked">
|
|
<summary>
|
|
3D Stacked Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bar3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bubble">
|
|
<summary>
|
|
Bubble series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Bubble3D">
|
|
<summary>
|
|
3D Bubble series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Column">
|
|
<summary>
|
|
Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.ColumnStacked">
|
|
<summary>
|
|
Stacked Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.ColumnPercentStacked">
|
|
<summary>
|
|
100% Stacked Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Column3D">
|
|
<summary>
|
|
3D Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Column3DStacked">
|
|
<summary>
|
|
3D Stacked Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Column3DPercentStacked">
|
|
<summary>
|
|
3D 100% Stacked Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Column3DClustered">
|
|
<summary>
|
|
3D Clustered Column series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Doughnut">
|
|
<summary>
|
|
Doughnut series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Line">
|
|
<summary>
|
|
Line series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.LineStacked">
|
|
<summary>
|
|
Stacked Line series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.LinePercentStacked">
|
|
<summary>
|
|
100% Stacked Line series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Line3D">
|
|
<summary>
|
|
3D Line series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Pie">
|
|
<summary>
|
|
Pie series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Pie3D">
|
|
<summary>
|
|
3D Pie series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.PieOfBar">
|
|
<summary>
|
|
Pie of Bar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.PieOfPie">
|
|
<summary>
|
|
Pie of Pie series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Radar">
|
|
<summary>
|
|
Radar series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Scatter">
|
|
<summary>
|
|
Scatter series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Stock">
|
|
<summary>
|
|
Stock series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Surface">
|
|
<summary>
|
|
Surface series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Surface3D">
|
|
<summary>
|
|
3D Surface series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Treemap">
|
|
<summary>
|
|
Treemap series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Sunburst">
|
|
<summary>
|
|
Sunburst series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Histogram">
|
|
<summary>
|
|
Histogram series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Pareto">
|
|
<summary>
|
|
Pareto series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.ParetoLine">
|
|
<summary>
|
|
ParetoLine series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.BoxAndWhisker">
|
|
<summary>
|
|
BoxAndWhisker series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Waterfall">
|
|
<summary>
|
|
Waterfall series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.Funnel">
|
|
<summary>
|
|
Funnel series.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.ChartSeriesType.RegionMap">
|
|
<summary>
|
|
RegionMap series.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.TextVerticalType">
|
|
<summary>
|
|
Specifies type of text direction.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.TextVerticalType.Horizontal">
|
|
<summary>
|
|
Horizontal type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.TextVerticalType.Vertical">
|
|
<summary>
|
|
Vertical type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.TextVerticalType.Vertical90">
|
|
<summary>
|
|
All text rot 90°.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.TextVerticalType.Vertical270">
|
|
<summary>
|
|
All text rot 270°.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.TextVerticalType.EastAsianVertical">
|
|
<summary>
|
|
East Asian text vertical.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.LabelAlignment">
|
|
<summary>
|
|
Specifies the possible alignment for the tick labels of chart axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LabelAlignment.Default">
|
|
<summary>
|
|
The labels alignment is not specified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LabelAlignment.Center">
|
|
<summary>
|
|
Specifies that the labels are centered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LabelAlignment.Left">
|
|
<summary>
|
|
Specifies that the labels are left justified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LabelAlignment.Right">
|
|
<summary>
|
|
Specifies that the labels are right justified.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisCrosses">
|
|
<summary>
|
|
Specifies the possible crossing points for an axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCrosses.AutoZero">
|
|
<summary>
|
|
The category axis crosses at the zero point of the value axis (if possible), or at the minimum value
|
|
if the minimum is greater than zero, or at the maximum if the maximum is less than zero.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCrosses.Max">
|
|
<summary>
|
|
A perpendicular axis crosses at the maximum value of the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCrosses.Min">
|
|
<summary>
|
|
A perpendicular axis crosses at the minimum value of the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisCrosses.Custom">
|
|
<summary>
|
|
A perpendicular axis crosses at the specified value of the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.LegendPosition">
|
|
<summary>
|
|
Specifies the possible positions for a chart legend.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.None">
|
|
<summary>
|
|
No legend will be shown for the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.Bottom">
|
|
<summary>
|
|
Specifies that the legend shall be drawn at the bottom of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.Left">
|
|
<summary>
|
|
Specifies that the legend shall be drawn at the left of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.Right">
|
|
<summary>
|
|
Specifies that the legend shall be drawn at the right of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.Top">
|
|
<summary>
|
|
Specifies that the legend shall be drawn at the top of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.LegendPosition.TopRight">
|
|
<summary>
|
|
Specifies that the legend shall be drawn at the top right of the chart.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol">
|
|
<summary>
|
|
Specifies marker symbol style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Default">
|
|
<summary>
|
|
Specifies a default marker symbol shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Circle">
|
|
<summary>
|
|
Specifies a circle shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Dash">
|
|
<summary>
|
|
Specifies a dash shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Diamond">
|
|
<summary>
|
|
Specifies a diamond shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Dot">
|
|
<summary>
|
|
Specifies a dot shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.None">
|
|
<summary>
|
|
Specifies nothing shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Picture">
|
|
<summary>
|
|
Specifies a picture shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Plus">
|
|
<summary>
|
|
Specifies a plus shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Square">
|
|
<summary>
|
|
Specifies a square shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Star">
|
|
<summary>
|
|
Specifies a star shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.Triangle">
|
|
<summary>
|
|
Specifies a triangle shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.MarkerSymbol.X">
|
|
<summary>
|
|
Specifies an X shall be drawn at each data point.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition">
|
|
<summary>
|
|
Specifies the possible positions for tick labels.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition.High">
|
|
<summary>
|
|
Specifies the axis labels shall be at the high end of the perpendicular axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition.Low">
|
|
<summary>
|
|
Specifies the axis labels shall be at the low end of the perpendicular axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition.NextTo">
|
|
<summary>
|
|
Specifies the axis labels shall be next to the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition.None">
|
|
<summary>
|
|
Specifies the axis labels are not drawn.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickLabelPosition.Default">
|
|
<summary>
|
|
Specifies default value of tick labels position.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisTickMark">
|
|
<summary>
|
|
Specifies the possible positions for tick marks.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickMark.Cross">
|
|
<summary>
|
|
Specifies that the tick marks shall cross the axis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickMark.Inside">
|
|
<summary>
|
|
Specifies that the tick marks shall be inside the plot area.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickMark.Outside">
|
|
<summary>
|
|
Specifies that the tick marks shall be outside the plot area.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTickMark.None">
|
|
<summary>
|
|
Specifies that there shall be no tick marks.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Charts.AxisTimeUnit">
|
|
<summary>
|
|
pecifies the unit of time for axes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTimeUnit.Auto">
|
|
<summary>
|
|
Specifies that unit was not set explicitly and default value should be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTimeUnit.Days">
|
|
<summary>
|
|
Specifies that the chart data shall be shown in days.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTimeUnit.Months">
|
|
<summary>
|
|
Specifies that the chart data shall be shown in months.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Fields.Shapes.Charts.AxisTimeUnit.Years">
|
|
<summary>
|
|
Specifies that the chart data shall be shown in years.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Shading.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.
|
|
</summary>
|
|
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.Shading.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shading.BackgroundPatternColor">
|
|
<summary>
|
|
Gets or sets the color of the background pattern.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shading.ForegroundPatternColor">
|
|
<summary>
|
|
Gets or sets the color of the foreground pattern.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shading.TextureStyle">
|
|
<summary>
|
|
Gets or sets the texture style.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.ShapeAdjustHandles">
|
|
<summary>
|
|
This class contains methods for adjusting the preset geometric shapes.
|
|
The user interface can be made to transform only certain parts of the shape
|
|
by using the special points (can alse be called adjust handles), similar
|
|
functionality can be implemented using this class.
|
|
(See <see cref="P:Spire.Doc.Fields.ShapeObject.AdjustHandles"/>.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeAdjustHandles.GetRoundRectangleCornerRadius">
|
|
<summary>
|
|
Gets the corner radius of the round rectangle shape.
|
|
This method is only applicable to <see cref="F:Spire.Doc.Documents.ShapeType.RoundRectangle"/>.
|
|
</summary>
|
|
<returns>The corner radius.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeAdjustHandles.AdjustRoundRectangle(System.Double)">
|
|
<summary>
|
|
Adjusts the corner radius of the round rectangle shape.
|
|
The maximum corner radius is half the smaller dimension
|
|
of the length and width of the rectangle.
|
|
This method is only applicable to <see cref="F:Spire.Doc.Documents.ShapeType.RoundRectangle"/>.
|
|
</summary>
|
|
<param name="cornerRadius">The value of the corner radius.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.DigitalSignature">
|
|
<summary>
|
|
Represents a digital signature in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.DigitalSignature.SignTime">
|
|
<summary>
|
|
Gets the system date/time of the current signature.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.DigitalSignature.Comments">
|
|
<summary>
|
|
Gets the purpose for signing this document of the current signature.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.DigitalSignature.SignerRole">
|
|
<summary>
|
|
Gets the signer role/title of the current signature.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.DigitalSignature.ToString">
|
|
<summary>
|
|
Returns a string representation of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.DigitalSignatureCollection">
|
|
<summary>
|
|
Represents a collection of digital signatures.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.DigitalSignatureCollection.Count">
|
|
<summary>
|
|
Gets the count of signatures int the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.DigitalSignatureCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets the <see cref="T:Spire.Doc.Fields.Shapes.DigitalSignature"/> at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index.</param>
|
|
<returns>The specified <see cref="T:Spire.Doc.Fields.Shapes.DigitalSignature"/>.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.DigitalSignatureCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator for the current collection.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Fill">
|
|
<summary>
|
|
Represents a class for filling data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Fill.Color">
|
|
<summary>
|
|
Gets or sets the color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Fill.Opacity">
|
|
<summary>
|
|
Gets or sets the opacity of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Fill.On">
|
|
<summary>
|
|
Gets or sets a value indicating whether the Fill is currently on.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Fill.ImageBytes">
|
|
<summary>
|
|
Gets or sets the image bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.Shape">
|
|
<summary>
|
|
Represents an abstract base class for shapes that implements the ITextBox interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.HasImage">
|
|
<summary>
|
|
Returns true if the shape has image bytes or links an image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.FirstParagraph">
|
|
<summary>
|
|
Gets the first paragraph in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.LastParagraph">
|
|
<summary>
|
|
Gets the last paragraph in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.HasChart">
|
|
<summary>
|
|
Returns true if this shape has a chart.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.Shape.Chart">
|
|
<summary>
|
|
Returns a chart object.
|
|
If there is a chart associated with this shape,
|
|
it allows for the manipulation of chart.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Shapes.ShapeBase">
|
|
<summary>
|
|
Base class for objects in the Psawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.GetDirectShapeAttr(System.Int32)">
|
|
<summary>
|
|
Retrieves the attribute of a DirectShape using the specified key.
|
|
</summary>
|
|
<param name="key">The key corresponding to the attribute to be retrieved.</param>
|
|
<returns>The attribute value associated with the key, or null if the key is not found.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.FetchInheritedShapeAttr(System.Int32)">
|
|
<summary>
|
|
Fetches the inherited shape attribute associated with the specified key.
|
|
</summary>
|
|
<param name="key">The key of the inherited shape attribute to fetch.</param>
|
|
<returns>The object representing the inherited shape attribute, or null if no attribute is found for the given key.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.FetchShapeAttr(System.Int32)">
|
|
<summary>
|
|
Fetches the attribute of a shape based on the provided key.
|
|
</summary>
|
|
<param name="key">The key corresponding to the attribute of the shape to be fetched.</param>
|
|
<returns>The attribute of the shape as an object.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.SetShapeAttr(System.Int32,System.Object)">
|
|
<summary>
|
|
Sets the attribute of a shape with the specified key to the given value.
|
|
</summary>
|
|
<param name="key">The key of the attribute to set.</param>
|
|
<param name="value">The value to set for the attribute.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.RemoveShapeAttr(System.Int32)">
|
|
<summary>
|
|
Removes the shape attribute associated with the specified key.
|
|
</summary>
|
|
<param name="key">The key of the shape attribute to be removed.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.GetDirectShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.GetInheritedShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.GetShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.SetShapeAttribute(System.Int32,System.Object)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.RemoveShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.HasKey(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.LocalToParent(System.Drawing.PointF)">
|
|
<summary>
|
|
Converts a point from local coordinates to parent coordinates.
|
|
</summary>
|
|
<param name="value">The point in local coordinates.</param>
|
|
<returns>The point converted to parent coordinates.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.SetShapeType(Spire.Doc.Documents.ShapeType)">
|
|
<summary>
|
|
Sets the shape type. Users are not to modify shape type directly.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.ChildObjects">
|
|
<summary>
|
|
Gets the child objects of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HRef">
|
|
<summary>
|
|
Gets or sets the hyperlink address of the shape.
|
|
</summary>
|
|
<value>The hyperlink address as a string.</value>
|
|
<param name="value">The hyperlink address to set.</param>
|
|
<returns>The hyperlink address of the shape.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the value parameter is null.</exception>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.AlternativeText">
|
|
<summary>
|
|
Gets or sets the alternative text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.AspectRatioLocked">
|
|
<summary>
|
|
Gets or sets the boolean valut. Specifies that the generating application should not allow aspect ratio changes
|
|
for the corresponding graphic frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.AllowOverlap">
|
|
<summary>
|
|
Gets or sets the boolean a value. Specifies whether this shape can overlap other shapes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.BehindText">
|
|
<summary>
|
|
Gets or sets the boolean a valut. Specifies whether the shape is below or above text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HorizontalPosition">
|
|
<summary>
|
|
Gets or sets the horizontal position of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.VerticalPosition">
|
|
<summary>
|
|
Gets or sets the vertical position of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Right">
|
|
<summary>
|
|
Gets the position of the right edge of the containing block of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Bottom">
|
|
<summary>
|
|
Gets the position of the bottom edge of the containing block of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Width">
|
|
<summary>
|
|
Gets or sets the width of the containing block of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Height">
|
|
<summary>
|
|
Gets or sets the height of the containing block of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.DistanceTop">
|
|
<summary>
|
|
Gets or sets the distance between the document text and the top edge of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.DistanceBottom">
|
|
<summary>
|
|
Gets or sets the distance between the document text and the bottom edge of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.DistanceLeft">
|
|
<summary>
|
|
Gets or sets the distance between the document text and the left edge of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.DistanceRight">
|
|
<summary>
|
|
Gets or sets the distance between the document text and the right edge of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Rotation">
|
|
<summary>
|
|
Gets or sets the rotation angle in degrees.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.ZOrder">
|
|
<summary>
|
|
Determines the display order of overlapping shapes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Shapes.ShapeBase.AdjustWithEffects(System.Drawing.RectangleF)">
|
|
<summary>
|
|
Adds to the source rectangle value of the effect extent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.ShapeType">
|
|
<summary>
|
|
Gets the shape type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HorizontalOrigin">
|
|
<summary>
|
|
Specifies relative to what the shape is positioned horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.VerticalOrigin">
|
|
<summary>
|
|
Specifies relative to what the shape is positioned vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HorizontalAlignment">
|
|
<summary>
|
|
Specifies how the shape is positioned horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.VerticalAlignment">
|
|
<summary>
|
|
Specifies how the shape is positioned vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.WrapType">
|
|
<summary>
|
|
Gets or sets the style of text wrapping used in the text container.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.TextWrappingStyle">
|
|
<summary>
|
|
Gets or sets the text wrapping style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.TextWrappingType">
|
|
<summary>
|
|
Specifies how the text is wrapped around the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.CoordOrigin">
|
|
<summary>
|
|
Gets or sets the origin coordinates of the point.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.CoordSize">
|
|
<summary>
|
|
Gets or sets the size of the coordinate.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.IsSignatureLine">
|
|
<summary>
|
|
Gets a value indicating whether the shape is a signature line.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.Size">
|
|
<summary>
|
|
Gets the size of the shape in its native units. Top level shapes are in points. Child shapes are in parent coordinate system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HasHyperlink">
|
|
<summary>
|
|
Determines whether the current shape contains hyperlink.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Shapes.ShapeBase.HasImage">
|
|
<summary>
|
|
Returns true if the shape has image bytes or links an image.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.WordArt">
|
|
<summary>
|
|
Defines the text and formatting of the text path (of a WordArt object).
|
|
</summary>
|
|
<remarks>
|
|
<p>Use the <see cref="P:Spire.Doc.Fields.Shapes.Shape.TextPath"/> property to access WordArt properties of a shape.
|
|
You do not create instances of the <see cref="!:TextPath"/> class directly.</p>
|
|
|
|
<seealso cref="T:Spire.Doc.Fields.WordArt"/>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.FontFamily">
|
|
<summary>
|
|
Defines the family of the textpath font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.Size">
|
|
<summary>
|
|
Defines the size of the font in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.Bold">
|
|
<summary>
|
|
True if the font is formatted as bold.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.Italic">
|
|
<summary>
|
|
True if the font is formatted as italic.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.SmallCaps">
|
|
<summary>
|
|
True if the font is formatted as small capital letters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.WordArt.Text">
|
|
<summary>
|
|
Defines the text of the text path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.OMath.OfficeMath">
|
|
<summary>
|
|
Defines the Office Math class such as function, equation
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.OMath.OfficeMath"/> class.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.CloneImpl">
|
|
<summary>
|
|
Creates a shallow copy of the current object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.OMath.OfficeMath.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.OMath.OfficeMath.ParentParagraph">
|
|
<summary>
|
|
Gets the parent paragraph.
|
|
</summary>
|
|
<value>The parent paragraph.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.FromMathMLCode(System.String)">
|
|
<summary>
|
|
Parses MathML code strings and update the current object.
|
|
</summary>
|
|
<param name="mathCode">The MathML code or Office MathML code to parse.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.FromOMMLCode(System.String)">
|
|
<summary>
|
|
Parses OMML (Office MathML) code strings and update the current object.
|
|
</summary>
|
|
<param name="ommlCode">The OMML code string.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.FromLatexMathCode(System.String)">
|
|
<summary>
|
|
Parses the LaTeX math code strings and update the current object.
|
|
</summary>
|
|
<param name="latexMathCode">The LaTeX math expression.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.FromEqField(Spire.Doc.Fields.Field)">
|
|
<summary>
|
|
Froms the EqField.
|
|
</summary>
|
|
<param name="eqField">The EqField object.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.SaveAsImage(Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Save the OfficeMath object as Image
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.ToMathMLCode">
|
|
<summary>
|
|
Converts the current math object to standard MathML code.
|
|
</summary>
|
|
<returns>The MathML representation of the math object as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.ToOfficeMathMLCode">
|
|
<summary>
|
|
Converts the current math object to Office MathML (OMML) code.
|
|
</summary>
|
|
<returns>The OMML representation of the math object as a string.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.OMath.OfficeMath.ToLaTexMathCode">
|
|
<summary>
|
|
Converts the current math object to LaTeX math code.
|
|
</summary>
|
|
<returns>The LaTeX representation of the math object.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.OMath.OfficeMath.ChildObjects">
|
|
<summary>
|
|
Gets a collection of child objects associated with this document object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.ShapeGroup">
|
|
<summary>
|
|
Represents a group of shapes in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ShapeGroup.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Creates a new group shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeGroup.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.DisplayAsIcon">
|
|
<summary>
|
|
Gets or sets whether the OLEObject is displayed as an Icon or Content. If True, the OLEObject is displayed as an icon
|
|
</summary>
|
|
<value>bool</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.OlePicture">
|
|
<summary>
|
|
Gets the OLE picture.
|
|
</summary>
|
|
<value>The OLE picture.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.Container">
|
|
<summary>
|
|
Gets the OLE container.
|
|
</summary>
|
|
<value>The container.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.IsComposite">
|
|
<summary>
|
|
Indicating whether this instance is composite.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.OleStorageName">
|
|
<summary>
|
|
Gets the name of the OLE Object storage.
|
|
</summary>
|
|
<value>The name of the OLE storage.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.LinkPath">
|
|
<summary>
|
|
Gets or sets the link path.
|
|
</summary>
|
|
<value>The link address.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.LinkType">
|
|
<summary>
|
|
Gets the type of the OLE object.
|
|
</summary>
|
|
<value>The type of the OLE obj.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.ProgId">
|
|
<summary>
|
|
Gets the programmatic identifier of the OLE object of an undefined type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.ObjectType">
|
|
<summary>
|
|
Gets or sets the type of the OLE object.
|
|
</summary>
|
|
<value>The type of the object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.NativeData">
|
|
<summary>
|
|
Gets the native data of embedded OLE object.
|
|
</summary>
|
|
<value>The native data.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocOleObject.PackageFileName">
|
|
<summary>
|
|
Gets the name of file embedded in the package (only if OleType is "Package").
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocOleObject.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the OleObject class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocOleObject.SetNativeData(System.Byte[])">
|
|
<summary>
|
|
Sets the native data.
|
|
</summary>
|
|
<param name="nativeData">The native data.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocOleObject.SetOlePicture(Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Sets the OLE picture.
|
|
</summary>
|
|
<param name="picture">The picture.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.ChildObjects">
|
|
<summary>
|
|
Gets the child objects of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.OwnerParagraph">
|
|
<summary>
|
|
Gets owner paragraph.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.IsInsertRevision">
|
|
<summary>
|
|
Gets a value indicating whether this item was inserted to the document,
|
|
when "Track Changes" is or was set to "true".
|
|
</summary>
|
|
<value>
|
|
if this instance was inserted, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.IsDeleteRevision">
|
|
<summary>
|
|
Gets or set a value indicating whether this item was deleted from the document,
|
|
when "Track Changes" is or was set to "true".
|
|
</summary>
|
|
<value>
|
|
if this instance is delete revision, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.IsMoveFromRevision">
|
|
<summary>
|
|
Gets a value indicating whether the run has a move from revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.IsMoveToRevision">
|
|
<summary>
|
|
Determines if the run properties have a move to revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.DeleteRevision">
|
|
<summary>
|
|
Gets the delete revision for this objects.
|
|
Note this can be null. If null does not have delete revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.InsertRevision">
|
|
<summary>
|
|
Gets the insert revision for this objects.
|
|
Note this can be null. If null does not have insert revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.MoveToRevision">
|
|
<summary>
|
|
Gets the MoveTo revision for this objects.
|
|
Note this can be null. If null does not have MoveTo revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.MoveFromRevision">
|
|
<summary>
|
|
Gets the MoveFrom revision for this objects.
|
|
Note this can be null. If null does not have MoveFrom revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.StyleName">
|
|
<summary>
|
|
Gets the style name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ParagraphBase.CharacterFormat">
|
|
<summary>
|
|
Gets the character format.
|
|
</summary>
|
|
<value>The paragraph item character format.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ParagraphBase.ApplyCharacterFormat(Spire.Doc.Formatting.CharacterFormat)">
|
|
<summary>
|
|
Applies the specified character format to the current object.
|
|
</summary>
|
|
<param name="charFormat">The character format to apply.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ParagraphBase.ApplyStyle(System.String)">
|
|
<summary>
|
|
Applies the specified character style to the current object.
|
|
If the specified style does not exist and the style name is "default paragraph font",
|
|
a new built-in style is created and added to the document.
|
|
If the specified style still cannot be found, an ArgumentException is thrown.
|
|
</summary>
|
|
<param name="styleName">The name of the character style to apply.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ParagraphBase.GetPreviousWidgetSibling">
|
|
<summary>
|
|
Gets the previous widget sibling.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ParagraphBase.GetNextWidgetSibling">
|
|
<summary>
|
|
Gets the next widget sibling.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.ShapeObject">
|
|
<summary>
|
|
Represents a shape object that inherits from the Shapes.Shape class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.FillColor">
|
|
<summary>
|
|
Defines the brush color that fills the closed path of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.FillTransparency">
|
|
<summary>
|
|
Set the fill transparency of the shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.StrokeWeight">
|
|
<summary>
|
|
Defines the brush thickness that strokes the path of a shape in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.StrokeColor">
|
|
<summary>
|
|
Defines the color of a stroke.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.LineStyle">
|
|
<summary>
|
|
Defines the line style of the stroke.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.LineDashing">
|
|
<summary>
|
|
Defines the line dashing of the stroke.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.WordArt">
|
|
<summary>
|
|
Defines the text of the text path (of a WordArt object).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.ExtrusionEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the extrusion feature is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.ShadowEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the shadow effect is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.AdjustHandles">
|
|
<summary>
|
|
Provides methods for adjusting the preset geometric shapes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ShapeObject.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Ctor. Use this internally only.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.ShapeObject.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.Documents.ShapeType)">
|
|
<summary>
|
|
Creates a new shape object.
|
|
</summary>
|
|
<param name="doc">The owner document.</param>
|
|
<param name="shapeType">The type of the shape to create.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ShapeObject.ChildObjects">
|
|
<summary>
|
|
Gets the child objects of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.TableOfContent">
|
|
<summary>
|
|
Represents a table of contents in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UseAbsolutePos">
|
|
<summary>
|
|
Gets or sets a value indicating whether absolute positioning should be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UseHeadingStyles">
|
|
<summary>
|
|
Gets or sets a value indicating whether to use default heading styles.
|
|
</summary>
|
|
<value>if it uses heading styles, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UpperHeadingLevel">
|
|
<summary>
|
|
Gets or sets the ending heading level of the table of content. Default value is 3.
|
|
</summary>
|
|
<value>The upper heading level.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.LowerHeadingLevel">
|
|
<summary>
|
|
Gets or sets the starting heading level of the table of content. Default value is 1
|
|
</summary>
|
|
<value>The starting heading level.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UseTableEntryFields">
|
|
<summary>
|
|
Gets or sets a value indicating whether to use table entry fields.Default value is false.
|
|
</summary>
|
|
<value>
|
|
if it uses table entry fields, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.TableID">
|
|
<summary>
|
|
Gets or sets the table ID.
|
|
</summary>
|
|
<value>The table ID.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.RightAlignPageNumbers">
|
|
<summary>
|
|
Gets or sets a value indicating whether to show page numbers from right side. Default value is true.
|
|
</summary>
|
|
<value>
|
|
if right align of page numbers, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.IncludePageNumbers">
|
|
<summary>
|
|
Gets or sets a value indicating whether to show page numbers. Default value is true.
|
|
</summary>
|
|
<value>if it includes page numbers, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UseHyperlinks">
|
|
<summary>
|
|
Gets or sets a value indicating whether to use hyperlinks.Default value is true.
|
|
</summary>
|
|
<value>if it uses hyperlinks, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.UseOutlineLevels">
|
|
<summary>
|
|
Gets or sets a value indicating whether use outline levels.Default value is false.
|
|
</summary>
|
|
<value>if it uses outline levels, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TableOfContent.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TableOfContent.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.TableOfContent"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TableOfContent.#ctor(Spire.Doc.Interface.IDocument,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.TableOfContent"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="switches">The switches.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TableOfContent.SetTOCLevelStyle(System.Int32,System.String)">
|
|
<summary>
|
|
Sets the style for TOC level.
|
|
</summary>
|
|
<param name="levelNumber">The level number.</param>
|
|
<param name="styleName">Name of the style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TableOfContent.GetTOCLevelStyle(System.Int32)">
|
|
<summary>
|
|
Gets the style name for TOC level.
|
|
</summary>
|
|
<param name="levelNumber">The level number.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.CheckBoxFormField">
|
|
<summary>
|
|
Represents a checkbox form field within a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.CheckBoxFormField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.CheckBoxFormField.CheckBoxSize">
|
|
<summary>
|
|
Gets or sets size of checkbox.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.CheckBoxFormField.DefaultCheckBoxValue">
|
|
<summary>
|
|
Gets or sets default checkbox value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.CheckBoxFormField.Checked">
|
|
<summary>
|
|
Gets or sets Checked property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.CheckBoxFormField.SizeType">
|
|
<summary>
|
|
Gets or sets check box size type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.CheckBoxFormField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.CheckBoxFormField"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Comment">
|
|
<summary>
|
|
Represents a container for text of a comment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.ChildObjects">
|
|
<summary>
|
|
Gets the child document objects.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.Body">
|
|
<summary>
|
|
Gets comment body.
|
|
</summary>
|
|
<value>The text body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.Format">
|
|
<summary>
|
|
Gets the format.
|
|
</summary>
|
|
<value>The format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.Items">
|
|
<summary>
|
|
Gets the range of commented items.
|
|
</summary>
|
|
<value>The range comment contains.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.ReplyCommentItems">
|
|
<summary>
|
|
Gets the range of commented items.
|
|
</summary>
|
|
<value>The reply commented range.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.ByRepliedComment">
|
|
<summary>
|
|
Gets the comment of current comment replied.
|
|
</summary>
|
|
<value>Comment of by reply.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.MarkDone">
|
|
<summary>
|
|
Gets a value indicating whether done.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.CommentMarkStart">
|
|
<summary>
|
|
Gets the begining mark of the comment.
|
|
</summary>
|
|
<value>The commentMark of start.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Comment.CommentMarkEnd">
|
|
<summary>
|
|
Gets the ending mark of the comment.
|
|
</summary>
|
|
<value>The commentMark of end.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:WComment"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.Clear">
|
|
<summary>
|
|
Clears the commented items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.Replace(System.String)">
|
|
<summary>
|
|
Replace commented items with matchString text.
|
|
</summary>
|
|
<param name="text">The text.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.Replace(Spire.Doc.Documents.TextBodyPart)">
|
|
<summary>
|
|
Replaces the commented items with specified TextBodyPart.
|
|
</summary>
|
|
<param name="textBodyPart">The text body part.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.AddItem(Spire.Doc.Interface.IParagraphBase)">
|
|
<summary>
|
|
Adds the paragraph item to the commented items.
|
|
</summary>
|
|
<param name="paraItem">The paragraph item.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.ReplyToComment(Spire.Doc.Fields.Comment)">
|
|
<summary>
|
|
Replies to comment.
|
|
</summary>
|
|
<param name="replyComment">the reply comment.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Comment.MarkCommentDone(System.Boolean)">
|
|
<summary>
|
|
Marks the comment done.
|
|
</summary>
|
|
<param name="done">the done.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.DropDownFormField">
|
|
<summary>
|
|
Represents a drop-down form field in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DropDownFormField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.DropDownFormField"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DropDownFormField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DropDownFormField.DropDownSelectedIndex">
|
|
<summary>
|
|
Gets or sets selected drop down index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DropDownFormField.DropDownItems">
|
|
<summary>
|
|
Gets drop down items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.ControlField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Field">
|
|
<summary>
|
|
Represents a field within a document, inheriting from TextRange.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.IsLocked">
|
|
<summary>
|
|
Gets or sets the lock property of the filed.if the field is locked,the field can't be updated.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.TextFormat">
|
|
<summary>
|
|
Gets or sets regular text format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.Pattern">
|
|
<summary>
|
|
Returns or sets field pattern.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.Value">
|
|
<summary>
|
|
Gets the field value.
|
|
</summary>
|
|
<value>The field value.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.Type">
|
|
<summary>
|
|
Returns or sets field type
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.Code">
|
|
<summary>
|
|
Gets or sets the field code.
|
|
</summary>
|
|
<value>The field code.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.Separator">
|
|
<summary>
|
|
Gets or sets the field separator.
|
|
</summary>
|
|
<value>The field separator.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.End">
|
|
<summary>
|
|
Gets or sets the field end.
|
|
</summary>
|
|
<value>The field mark,Type of FieldEnd. </value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Field.FieldText">
|
|
<summary>
|
|
Gets or Sets Filed Displays text information.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Field.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Creates Field object for specified document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Field.Update">
|
|
<summary>
|
|
Update the result of the field.
|
|
Can only be simpler field.
|
|
Direct calls cannot update the NumPages field and Page field, ect.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Field.GetFieldCode">
|
|
<summary>
|
|
Gets the field code.
|
|
</summary>
|
|
<value>The field code.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.UpdateFieldsHandler">
|
|
<summary>
|
|
Represents the method that will handle an event that with event data.
|
|
</summary>
|
|
<param name="sender">The source of the event</param>
|
|
<param name="args">The <see cref="T:Spire.Doc.Fields.IFieldsEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.IFieldsEventArgs">
|
|
<summary>
|
|
Interface IFieldsEventArgs
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.IFieldsEventArgs.Field">
|
|
<summary>
|
|
Gets the field.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.AskFieldEventArgs">
|
|
<summary>
|
|
Class AskFieldEventArgs;
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.Field">
|
|
<summary>
|
|
Gets
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.PromptText">
|
|
<summary>
|
|
Gets the prompt text;
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.DefaultResponse">
|
|
<summary>
|
|
Gets the default response.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.ResponseText">
|
|
<summary>
|
|
Gets or sets the response text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.Cancel">
|
|
<summary>
|
|
Gets or sets a value indicating whether cancel to answer the question.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.AskFieldEventArgs.BookmarkName">
|
|
<summary>
|
|
Gets the name of bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FieldMark.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FieldMark.Type">
|
|
<summary>
|
|
Gets or sets type of field mark.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.FieldMark.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.Documents.FieldMarkType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.FieldMark"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="type">The type.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Footnote">
|
|
<summary>
|
|
Represents a footnote in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.UseAbsolutePos">
|
|
<summary>
|
|
Indicates whether to use absolute positioning for the element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.FootnoteType">
|
|
<summary>
|
|
Gets or sets footnote type: footnote or endnote
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.IsAutoNumbered">
|
|
<summary>
|
|
Gets or sets the value indicating if the footnote is auto numbered
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.TextBody">
|
|
<summary>
|
|
Gets the text body of the footnote.
|
|
</summary>
|
|
<value>The text body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.MarkerCharacterFormat">
|
|
<summary>
|
|
Gets the marker character format
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.SymbolCode">
|
|
<summary>
|
|
Gets or sets the marker symbol code.
|
|
</summary>
|
|
<value>The symbol code.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.CustomMarker">
|
|
<summary>
|
|
Gets or sets the custom footnote marker.
|
|
</summary>
|
|
<value>The custom marker.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Footnote.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Footnote.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.Footnote"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Footnote.EnsureMinimum">
|
|
<summary>
|
|
Ensures that the minimum requirements are met.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.FormField">
|
|
<summary>
|
|
Represents an abstract class for form fields.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.FormFieldType">
|
|
<summary>
|
|
Gets type of this form field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.Name">
|
|
<summary>
|
|
Gets or sets form field title name (bookmark name).
|
|
The name is unique in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.Help">
|
|
<summary>
|
|
Gets or sets form field help.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.StatusBarHelp">
|
|
<summary>
|
|
Gets or sets the status bar help.
|
|
</summary>
|
|
<value>The status bar help.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.MacroOnStart">
|
|
<summary>
|
|
Returns or setsthe name of macros on start
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.MacroOnEnd">
|
|
<summary>
|
|
Returns or setsthe name of macros on end
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.Enabled">
|
|
<summary>
|
|
Get/sets Enabled property (true if form field enabled).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.FormField.CalculateOnExit">
|
|
<summary>
|
|
Gets or sets calculate on exit property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.FormField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.FormField"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.IfField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.IfField"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.MergeField">
|
|
<summary>
|
|
Represents a merge field in a document that can be replaced with data from a data source during the merge process.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.FieldName">
|
|
<summary>
|
|
Returns or sets field name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.Text">
|
|
<summary>
|
|
Gets or sets the text associated with this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.TextBefore">
|
|
<summary>
|
|
Returns or sets the text before merge field
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.TextAfter">
|
|
<summary>
|
|
Returns or sets the text after merge field
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.Prefix">
|
|
<summary>
|
|
Gets the prefix of merge field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.NumberFormat">
|
|
<summary>
|
|
Gets the number format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.DateFormat">
|
|
<summary>
|
|
Gets the date format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.MergeField.TextItems">
|
|
<summary>
|
|
Gets the text items.
|
|
</summary>
|
|
<value>The text items.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.MergeField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.MergeField"/> class.
|
|
</summary>
|
|
<param name="doc">The document</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.DocPicture">
|
|
<summary>
|
|
Represents a picture in a document.
|
|
Implements the IPicture and IDocumentWidget interfaces.
|
|
Inherits from ShapeObject.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Rotation">
|
|
<summary>
|
|
Gets/Sets the rotation of DocPicture.Specifies the rotation of the graphic frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Height">
|
|
<summary>
|
|
Returns or sets picture height.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Width">
|
|
<summary>
|
|
Returns or sets picture width.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.HeightScale">
|
|
<summary>
|
|
Returns or sets picture height scale factor in percent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.WidthScale">
|
|
<summary>
|
|
Returns or sets picture width scale factor in percent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.SetScale(System.Single)">
|
|
<summary>
|
|
Scale the image by scale factor.
|
|
</summary>
|
|
<param name="scaleFactor">The scale factor. The default unit is percentage.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.SetScale(System.Single,System.Single)">
|
|
<summary>
|
|
Scale the image by scale factor.
|
|
</summary>
|
|
<param name="heightFactor">The height scale factor. The default unit is percentage.</param>
|
|
<param name="widthFactor">The width scale factor. The default unit is percentage.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Image">
|
|
<summary>
|
|
Gets internal System.Drawing.Image object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.ImageBytes">
|
|
<summary>
|
|
Gets image byte array.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.GrayScale">
|
|
<summary>
|
|
Determines whether a picture will display in grayscale mode.
|
|
</summary>
|
|
<remarks>
|
|
<p>The default value is <b>false</b>.</p>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.BiLevel">
|
|
<summary>
|
|
Determines whether an image will be displayed in black and white.
|
|
</summary>
|
|
<remarks>
|
|
<p>The default value is <b>false</b>.</p>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Brightness">
|
|
<summary>
|
|
Gets or sets picture brightness.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Contrast">
|
|
<summary>
|
|
Get/set picture contrast.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Color">
|
|
<summary>
|
|
Gets or sets picture color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.TransparentColor">
|
|
<summary>
|
|
Gets or sets transparent color
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.IsCrop">
|
|
<summary>
|
|
Gets whether the picture object is cropped.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.HorizontalOrigin">
|
|
<summary>
|
|
Gets or sets horizontal origin of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.VerticalOrigin">
|
|
<summary>
|
|
Gets or sets Vertical origin of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.HorizontalPosition">
|
|
<summary>
|
|
Gets or sets absolute horizontal position of the picture.
|
|
</summary>
|
|
<remarks>
|
|
The value is measured in points and the position is relative to HorizontalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.VerticalPosition">
|
|
<summary>
|
|
Gets or sets absolute vertical position of the picture.
|
|
</summary>
|
|
<remarks>
|
|
The value is measured in points and the position is relative to VerticalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.TextWrappingStyle">
|
|
<summary>
|
|
Gets or sets text wrapping style of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.TextWrappingType">
|
|
<summary>
|
|
Gets or sets text wrapping type of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.HorizontalAlignment">
|
|
<summary>
|
|
Returns or setspicture horizontal alignment.
|
|
</summary>
|
|
<remarks>
|
|
If it is set as None, then the picture is explicitly positioned using position properties.
|
|
Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.VerticalAlignment">
|
|
<summary>
|
|
Returns or setspicture vertical alignment.
|
|
</summary>
|
|
<remarks>
|
|
If it is set as None, then the picture is explicitly positioned using position properties.
|
|
Otherwise it is positioned according to the alignment specified. The position of the object is relative to VerticalOrigin.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.IsUnderText">
|
|
<summary>
|
|
Gets or sets whether picture is below image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.Title">
|
|
<summary>
|
|
Gets the picture title.
|
|
</summary>
|
|
<value>The title.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.DocPicture.LayoutInCell">
|
|
<summary>
|
|
Gets or sets the boolean value that represents whether a picture in a table is displayed inside or outside the table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.DocPicture"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.LoadImage(System.Drawing.Image)">
|
|
<summary>
|
|
Loads image.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.LoadImage(System.String)">
|
|
<summary>
|
|
Loads the image.
|
|
</summary>
|
|
<param name="imgFile">The img file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.LoadImage(System.IO.Stream)">
|
|
<summary>
|
|
Loads the image.
|
|
</summary>
|
|
<param name="imgStream">The img stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.LoadImage(System.Byte[])">
|
|
<summary>
|
|
Loads image as bytes array.
|
|
</summary>
|
|
<param name="imageBytes"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.ReplaceImage(System.Byte[],System.Boolean)">
|
|
<summary>
|
|
Replaces the image.
|
|
</summary>
|
|
<param name="imageBytes">The image bytes.</param>
|
|
<param name="bIsKeepRation"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.DocPicture.AddCaption(System.String,Spire.Doc.CaptionNumberingFormat,Spire.Doc.CaptionPosition)">
|
|
<summary>
|
|
Add Caption for current Picture
|
|
</summary>
|
|
<param name="captionPosition"></param>
|
|
<param name="name"></param>
|
|
<param name="format"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.SequenceField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.SequenceField.FormattingString">
|
|
<summary>
|
|
Gets the formatting string
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.SequenceField.NumberFormat">
|
|
<summary>
|
|
Returns or setsthe type of caption numbering
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.SequenceField.CaptionName">
|
|
<summary>
|
|
Returns or sets caption name
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.SequenceField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.SequenceField"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.Symbol">
|
|
<summary>
|
|
Represents a symbol in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Symbol.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Symbol.FontName">
|
|
<summary>
|
|
Returns or setssymbol font name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.Symbol.CharacterCode">
|
|
<summary>
|
|
Returns or sets symbol's character code.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.Symbol.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializing constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.TextBox">
|
|
<summary>
|
|
Represents a text box shape object in a document.
|
|
Implements the ITextBox and IDocumentBase interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextBox.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextBox.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextBox.Format">
|
|
<summary>
|
|
Gets the format value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextBox.Body">
|
|
<summary>
|
|
Gets the text body value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TextBox.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.TextBox"/> class.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.TextFormField">
|
|
<summary>
|
|
Represents a text input form field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.TextFieldType">
|
|
<summary>
|
|
Get/sets text form field type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.StringFormat">
|
|
<summary>
|
|
Gets or sets string text format (text, date/time, number) directly.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.DefaultText">
|
|
<summary>
|
|
Gets or sets default text for text form field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.MaximumLength">
|
|
<summary>
|
|
Gets or sets maximum text length.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.TextRange">
|
|
<summary>
|
|
Gets or sets form field text range;
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextFormField.Text">
|
|
<summary>
|
|
Returns or setsthe text of text form field.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TextFormField.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.TextFormField"/> class.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Fields.TextRange">
|
|
<summary>
|
|
Represents a run of characters with the same font formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextRange.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Fields.TextRange.Text">
|
|
<summary>
|
|
Returns or sets text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Fields.TextRange.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.TextRange"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.PdfConformanceLevel">
|
|
<summary>
|
|
Specifies the Pdf document's Conformance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.None">
|
|
<summary>
|
|
Specifies Default / No Conformance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A1B">
|
|
<summary>
|
|
This PDF/A ISO standard [ISO 19005-1:2005] is based on Adobe PDF version 1.4
|
|
and This Level B conformance indicates minimal compliance to ensure that the
|
|
rendered visual appearance of a conforming file is preservable over the long term.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_X1A2001">
|
|
<summary>
|
|
This PDF/X-1a:2001 ISO standard [ISO 15930-1] is based on Adobe PDF version 1.3
|
|
which uses only CMYK + Spot Color and this compliance to ensure that the
|
|
contents will be reliably reproduced in the repress environment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A1A">
|
|
<summary>
|
|
PDF/A-1a ensures the preservation of a document's logical structure and con-tent text stream in natural reading order.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A2A">
|
|
<summary>
|
|
PDF/A-2a standard,Only check the standard from the pdfaid:part and pdfaid:conformance node,And only check.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A2B">
|
|
<summary>
|
|
PDF/A-2b standard,Only check the standard from the pdfaid:part and pdfaid:conformance node,And only check.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A3A">
|
|
<summary>
|
|
PDF/A-3a standard,Only check the standard from the pdfaid:part and pdfaid:conformance node,And only check
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_A3B">
|
|
<summary>
|
|
PDF/A-3b standard,Only check the standard from the pdfaid:part and pdfaid:conformance node,And only check
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfConformanceLevel.Pdf_UA1">
|
|
<summary>
|
|
PDF/UA-1 standard,Only check the standard from the pdfaid:part and pdfaid:conformance node,And only check
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PdfEncryptionKeySize">
|
|
<summary>
|
|
Specifies length of the encryption key for encryption.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfEncryptionKeySize.Key40Bit">
|
|
<summary>
|
|
The key is 40 bit long.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfEncryptionKeySize.Key128Bit">
|
|
<summary>
|
|
The key is 128 bit long.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfEncryptionKeySize.Key256Bit">
|
|
<summary>
|
|
The key is 256 bit long.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PdfImageCompression">
|
|
<summary>
|
|
Indicates the compression method used for images within the PDF file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfImageCompression.Auto">
|
|
<summary>
|
|
Automatically chooses the optimal compression method for each image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfImageCompression.Jpeg">
|
|
<summary>
|
|
Jpeg compression.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PdfPermissionsFlags">
|
|
<summary>
|
|
Specifies the available permissions set for the signature.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.None">
|
|
<summary>
|
|
Not all permissions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.Default">
|
|
<summary>
|
|
Default value is 2876. A common document contains all privileges
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.Print">
|
|
<summary>
|
|
Print the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.EditContent">
|
|
<summary>
|
|
Edit content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.CopyContent">
|
|
<summary>
|
|
Copy content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.EditAnnotations">
|
|
<summary>
|
|
Add or modify text annotations, fill in interactive form fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.FillFields">
|
|
<summary>
|
|
Fill form fields. (Only for 128 bits key).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.AccessibilityCopyContent">
|
|
<summary>
|
|
Copy accessibility content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.AssembleDocument">
|
|
<summary>
|
|
Assemble document permission. (Only for 128 bits key).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PdfPermissionsFlags.FullQualityPrint">
|
|
<summary>
|
|
Full quality print.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PdfSecurity">
|
|
<summary>
|
|
Represents the security settings of the PDF document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PdfSecurity.OwnerPassword">
|
|
<summary>
|
|
Gets the owner password.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PdfSecurity.UserPassword">
|
|
<summary>
|
|
Gets the user password.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PdfSecurity.Encrypt(System.String)">
|
|
<summary>
|
|
To Encrypt the PDF document with open password.
|
|
Note:If set empty string value to open password, it indicates that the PDF document can be operated without providing corresponding password.
|
|
Note: the document owner password should not be exist.
|
|
</summary>
|
|
<param name="openPassword">The open password</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PdfSecurity.Encrypt(System.String,Spire.Doc.PdfPermissionsFlags)">
|
|
<summary>
|
|
To Encrypt the PDF document with permission password and permissions.
|
|
Note:The Permission password can't be empty string.
|
|
</summary>
|
|
<param name="permissionPassword">The permission password</param>
|
|
<param name="permissions">A set of flags specifying which operations are permitted when the document is opened with user access</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PdfSecurity.Encrypt(System.String,System.String,Spire.Doc.PdfPermissionsFlags,Spire.Doc.PdfEncryptionKeySize)">
|
|
<summary>
|
|
To Encrypt the PDF document and set the encryption key size and permissions.
|
|
Note:If set empty string value to open password or permission password, it indicates that the PDF document can be operated without providing corresponding password.
|
|
</summary>
|
|
<param name="openPassword">The open password</param>
|
|
<param name="permissionPassword">The permission password</param>
|
|
<param name="permissions">A set of flags specifying which operations are permitted when the document is opened with user access</param>
|
|
<param name="keySize">The bit length of the encryption key</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.PdfSecurity.Permissions">
|
|
<summary>
|
|
Gets the document's permission flags
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PdfSecurity.KeySize">
|
|
<summary>
|
|
Gets the size of the key.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PdfSecurity.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ToPdfParameterList">
|
|
<summary>
|
|
To Pdf ParameterList
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.ExportDocumentStructureTags">
|
|
<summary>
|
|
Gets or sets a value determining whether or not to export document structure tags.
|
|
The default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.MimicWPSLayout">
|
|
<summary>
|
|
Gets or sets a value indicating whether to mimic the layout of WPS Application.
|
|
The default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.UseAuthorNameToDisplayCommentLabel">
|
|
<summary>
|
|
Gets or sets a value indicating whether display comment label with the author name.
|
|
The default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.UpdateFields">
|
|
<summary>
|
|
Gets or sets a value indicating whether to change the fields before
|
|
saving the document when using the new engine.
|
|
The default value is true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.UsePSCoversion">
|
|
<summary>
|
|
Gets or sets a value indicating whether use the PS conversion.
|
|
</summary>
|
|
<value><c>true</c> if use the PS conversion;otherwise,<c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.IsHidden">
|
|
<summary>
|
|
Gets or sets hidden text is converted.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.EmbeddedFontNameList">
|
|
<summary>
|
|
Gets or sets Embedded into the PDF document font name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.IsEmbeddedAllFonts">
|
|
<summary>
|
|
Gets or sets all fonts are embedded in the PDF document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.DisableLink">
|
|
<summary>
|
|
gets or sets whether remove the link on the hyperlink and keep the character format
|
|
during converting to pdf.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.IsAtLast">
|
|
<summary>
|
|
Gets or sets To Pdf TextBox HeightType.The default is "Exactly".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.PdfConformanceLevel">
|
|
<summary>
|
|
Gets or sets the Pdf document's Conformance-level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.PdfSecurity">
|
|
<summary>
|
|
Represents the security settings of the PDF document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.PdfImageCompression">
|
|
<summary>
|
|
Gets or sets the compression method used for images within the PDF file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.PrivateFontPaths">
|
|
<summary>
|
|
Gets or sets the private font paths.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.CreateWordBookmarksUsingHeadings">
|
|
<summary>
|
|
Gets or set the a value that determines whether create the bookmarks using Headings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.CreateWordBookmarks">
|
|
<summary>
|
|
Gets or set the a value, Whether to use word bookmars when create the bookmarks.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.WordBookmarksTitle">
|
|
<summary>
|
|
Gets or sets the word bookmarks title. The default value for this title is null.
|
|
</summary>
|
|
<value>The word bookmarks title.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.WordBookmarksColor">
|
|
<summary>
|
|
Gets or sets the text color of the word bookmarks.
|
|
the default value is the "SaddleBrown" color(#FF8B4513).
|
|
</summary>
|
|
<value>The text color of the word boomarks. </value>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.WordBookmarksTextStyle">
|
|
<summary>
|
|
Gets or sets the text style of the word bookmarks.
|
|
The default value is the Bold.
|
|
</summary>
|
|
<value>The word bookmarks text style.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.ToPdfParameterList.PreserveFormFields">
|
|
<summary>
|
|
Indicates whether form field values should be preserved after operations.
|
|
Default is <c>false</c>.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if form field values should be retained; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Background">
|
|
<summary>
|
|
Represents a background in a document.
|
|
Implements interfaces for serialization and shape attribute sourcing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Background.Type">
|
|
<summary>
|
|
Gets or Sets the type of background for document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Background.Picture">
|
|
<summary>
|
|
Gets or sets background picture.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Background.Color">
|
|
<summary>
|
|
Gets or sets background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Background.Gradient">
|
|
<summary>
|
|
Gets or sets background gradient.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.GetDirectShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.GetInheritedShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.GetShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.SetShapeAttribute(System.Int32,System.Object)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.SetShapeAttr(System.Int32,System.Object)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.RemoveShapeAttribute(System.Int32)">
|
|
<summary>
|
|
Reserved for system use. IShapeAttrSource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.HasKey(System.Int32)">
|
|
<summary>
|
|
Checks if the collection contains an element with the specified key.
|
|
</summary>
|
|
<param name="key">The key to search for.</param>
|
|
<returns>True if the key is found; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.SetPicture(System.String)">
|
|
<summary>
|
|
Sets the picture.
|
|
</summary>
|
|
<param name="imgFile">The image file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.SetPicture(System.IO.Stream)">
|
|
<summary>
|
|
Sets the picture.
|
|
</summary>
|
|
<param name="imgStream">The image stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.GetDirectShapeAttr(System.Int32)">
|
|
<summary>
|
|
Retrieves the value of a direct shape attribute using the specified key.
|
|
</summary>
|
|
<param name="key">The key of the attribute to retrieve.</param>
|
|
<returns>The value of the attribute, or null if the attribute does not exist.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.FetchInheritedShapeAttr(System.Int32)">
|
|
<summary>
|
|
Fetches the inherited shape attribute for the specified key.
|
|
</summary>
|
|
<param name="key">The key of the attribute to fetch.</param>
|
|
<returns>The inherited shape attribute, or null if not found.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.FetchShapeAttr(System.Int32)">
|
|
<summary>
|
|
Fetches the attribute of a shape based on the given key.
|
|
</summary>
|
|
<param name="key">The key of the attribute to fetch.</param>
|
|
<returns>The attribute value, or null if the key is not found.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Background.RemoveShapeAttr(System.Int32)">
|
|
<summary>
|
|
Removes a shape attribute by key.
|
|
</summary>
|
|
<param name="key">The key of the shape attribute to remove.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.BackgroundGradient">
|
|
<summary>
|
|
Represents a background gradient fill for a UI element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BackgroundGradient.Color1">
|
|
<summary>
|
|
Gets or sets first color for gradient.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BackgroundGradient.Color2">
|
|
<summary>
|
|
Gets or sets second color for gradient
|
|
(used when TwoColors set to true).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BackgroundGradient.ShadingStyle">
|
|
<summary>
|
|
Gets or sets shading style for gradient.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BackgroundGradient.ShadingVariant">
|
|
<summary>
|
|
Gets or sets shading variants.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Bookmark">
|
|
<summary>
|
|
Represents bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Bookmark.Name">
|
|
<summary>
|
|
Gets bookmark name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Bookmark.BookmarkStart">
|
|
<summary>
|
|
Gets the bookmark start.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Bookmark.BookmarkEnd">
|
|
<summary>
|
|
Gets the bookmark end.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Bookmark.#ctor(Spire.Doc.BookmarkStart)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Bookmark"/> class.
|
|
</summary>
|
|
<param name="start">The start.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Bookmark.#ctor(Spire.Doc.BookmarkStart,Spire.Doc.BookmarkEnd)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Bookmark"/> class.
|
|
</summary>
|
|
<param name="start">The bookmark start.</param>
|
|
<param name="end">The bookmark end.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.BuiltinDocumentProperties">
|
|
<summary>
|
|
Represents a class that inherits from SummaryDocumentProperties and provides built-in document properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.Category">
|
|
<summary>
|
|
Gets or sets the category of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.BytesCount">
|
|
<summary>
|
|
Gets the number of bytes in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.LinesCount">
|
|
<summary>
|
|
Gets the number of lines in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.ParagraphCount">
|
|
<summary>
|
|
Gets the number of paragraphs in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.CharCountWithSpace">
|
|
<summary>
|
|
Gets document characters count(including spaces)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.SlideCount">
|
|
<summary>
|
|
Gets slide count.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.NoteCount">
|
|
<summary>
|
|
Gets Note count.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.HiddenCount">
|
|
<summary>
|
|
Gets hidden count
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.Company">
|
|
<summary>
|
|
Returns or sets Company property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.HyperLinkBase">
|
|
<summary>
|
|
Returns or sets HyperLinkBase property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.Manager">
|
|
<summary>
|
|
Gets or sets Manager property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BuiltinDocumentProperties.ContentStatus">
|
|
<summary>
|
|
Gets or sets the document status.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.BuiltinDocumentProperties.Clone">
|
|
<summary>
|
|
Clone.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentSecurity">
|
|
<summary>
|
|
Represents the security level of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentSecurity.None">
|
|
<summary>
|
|
Indicates that the document security level is none.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentSecurity.PasswordProtected">
|
|
<summary>
|
|
Indicates that the document security level is password protected.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentSecurity.ReadOnlyRecommended">
|
|
<summary>
|
|
Indicates that the document security level is recommended to be read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentSecurity.ReadOnlyEnforced">
|
|
<summary>
|
|
Indicates that the document security level is forced to be read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentSecurity.ReadOnlyExceptAnnotations">
|
|
<summary>
|
|
Indicates that the document security level is read-only, except for annotations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Column">
|
|
<summary>
|
|
Represents a column in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Column.Width">
|
|
<summary>
|
|
Gets or sets the width of the column in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Column.Space">
|
|
<summary>
|
|
Gets or setss pacing between current and next column.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Column.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initialize constructor.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.CustomDocumentProperties">
|
|
<summary>
|
|
Represents custom document properties that can be serialized and deserialized.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CustomDocumentProperties.CustomHash">
|
|
<summary>
|
|
A dictionary to store custom document properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CustomDocumentProperties.Item(System.String)">
|
|
<summary>
|
|
Gets or sets property by specified name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CustomDocumentProperties.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets property by specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.CustomDocumentProperties.Count">
|
|
<summary>
|
|
Gets count of the properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.CustomDocumentProperties.Add(System.String,System.Object)">
|
|
<summary>
|
|
Adds the specified name.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.CustomDocumentProperties.Remove(System.String)">
|
|
<summary>
|
|
Remove property specified by name.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.CustomDocumentProperties.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentProperty">
|
|
<summary>
|
|
Summary description for DocumentProperty.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.#ctor">
|
|
<summary>
|
|
Default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.#ctor(System.String,System.Object)">
|
|
<summary>
|
|
Initializes new instance of the class.
|
|
</summary>
|
|
<param name="strName">Property name.</param>
|
|
<param name="value">Property value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.#ctor(System.String,System.Object,Spire.Doc.CompoundFile.PropertyType)">
|
|
<summary>
|
|
Initializes new instance of the class.
|
|
</summary>
|
|
<param name="strName">Property name.</param>
|
|
<param name="value">Property value.</param>
|
|
<param name="type">Property type</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperty.Name">
|
|
<summary>
|
|
Returns property name. Read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperty.Value">
|
|
<summary>
|
|
Gets / sets the property value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperty.ValueType">
|
|
<summary>
|
|
Gets the type of the value.
|
|
</summary>
|
|
<value>The type of the value.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperty.ClipboardData">
|
|
<summary>
|
|
Gets or sets clipboard data value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToBool">
|
|
<summary>
|
|
To the bool.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToDateTime">
|
|
<summary>
|
|
Convert the object in DateTime.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToFloat">
|
|
<summary>
|
|
Convert the object in float value.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToDouble">
|
|
<summary>
|
|
Convert the object in double.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToInt">
|
|
<summary>
|
|
Convert the object in Int value.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.ToByteArray">
|
|
<summary>
|
|
Convert the object as byte array.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentProperty.Clone">
|
|
<summary>
|
|
Creates a new object that is a copy of the current instance.
|
|
</summary>
|
|
<returns>A new object that is a copy of this instance.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootEndnoteOptions">
|
|
<summary>
|
|
Represents options for footnotes in a Word document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootEndnoteOptions.NumberFormat">
|
|
<summary>
|
|
Gets or sets the numbering format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootEndnoteOptions.Position">
|
|
<summary>
|
|
Gets or sets the position in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootEndnoteOptions.RestartRule">
|
|
<summary>
|
|
Gets or sets the restart rule.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootEndnoteOptions.StartNumber">
|
|
<summary>
|
|
Gets or sets the start number.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.FootEndnoteOptions.#ctor(Spire.Doc.Document,Spire.Doc.Documents.ISectionAttrSource,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the FootEndnoteOptions class, which is used to configure options for footnotes or endnotes.
|
|
</summary>
|
|
<param name="parent">The source of section attributes that this FootEndnoteOptions instance is associated with.</param>
|
|
<param name="doc">The document to which this FootEndnoteOptions instance applies.</param>
|
|
<param name="bIsFootnote">A boolean indicating whether the options are for footnotes (true) or endnotes (false).</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentObject">
|
|
<summary>
|
|
Represents a base class for document objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.ChildObjects">
|
|
<summary>
|
|
Gets the child objects of the entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.Owner">
|
|
<summary>
|
|
Gets the owner of this entity.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.PreviousSibling">
|
|
<summary>
|
|
Gets the previous sibling.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.NextSibling">
|
|
<summary>
|
|
Gets the next sibling.
|
|
</summary>
|
|
<value>The next sibling.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.IsComposite">
|
|
<summary>
|
|
Indicating whether this instance is composite.
|
|
</summary>
|
|
<value>
|
|
If this instance is composite, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.FirstChild">
|
|
<summary>
|
|
Gets the first child of the Element.
|
|
</summary>
|
|
<remarks>
|
|
If there is no first child Element, a null is returned.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentObject.LastChild">
|
|
<summary>
|
|
Gets the last child of the Element.
|
|
</summary>
|
|
<remarks>
|
|
If there is no last child Element, a null is returned.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentObject.Clone">
|
|
<summary>
|
|
Creates a duplicate of the document object.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentObject.ToString(System.String)">
|
|
<summary>
|
|
Exports the name and index in container of the object into a string in the specified seperator.
|
|
</summary>
|
|
<param name="seperator"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentObject.GetPreviousWidgetSibling">
|
|
<summary>
|
|
Gets the previous widget sibling.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentObject.GetNextWidgetSibling">
|
|
<summary>
|
|
Gets the next sibling.
|
|
</summary>
|
|
<value>The next sibling.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.HtmlExportOptions">
|
|
<summary>
|
|
Represents options for exporting documents to HTML format.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.HtmlExportOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the HtmlExportOptions class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.HtmlExportOptions.#ctor(Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Initializes a new instance of the HtmlExportOptions class with the specified file format.
|
|
</summary>
|
|
<param name="saveFileFormat">The file format to save the HTML document.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.EPubExportFont">
|
|
<summary>
|
|
Gets or sets if font should be embedded in EPub
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.CssStyleSheetType">
|
|
<summary>
|
|
Gets or sets the type of the HTML export CSS style sheet.
|
|
</summary>
|
|
<value>The type of the HTML export CSS style sheet.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.ImageEmbedded">
|
|
<summary>
|
|
If false,indicates exporting the image as a single file;
|
|
If true, embedding the image into the html code using Data URI scheme.
|
|
The default value is false.
|
|
Note: Internet Explorer 8 limits data URIs to a maximum length of 32KB.
|
|
</summary>
|
|
<value>The value of the HTML export image style sheet.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.IsExportDocumentStyles">
|
|
<summary>
|
|
Gets or Sets a switch that determines whether to export the document styles to head.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.CssStyleSheetFileName">
|
|
<summary>
|
|
Gets or sets the name of the HTML export CSS style sheet file.
|
|
</summary>
|
|
<value>The name of the HTML export CSS style sheet file.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.HasHeadersFooters">
|
|
<summary>
|
|
Gets or sets a value indicating whether HTML export headers footers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.IsTextInputFormFieldAsText">
|
|
<summary>
|
|
Gets or sets a value indicating whether HTML export text input form field as text.
|
|
</summary>
|
|
<value>
|
|
If HTML export text input form field as text, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.ImagesPath">
|
|
<summary>
|
|
Gets or sets the HTML export images folder.
|
|
</summary>
|
|
<value>The HTML export images folder.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.UseSaveFileRelativePath">
|
|
<summary>
|
|
Gets or sets a value whether Image Path is relative to the file save path.
|
|
</summary>
|
|
<value>
|
|
If Image Path wants to be relative to the file save path, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.HtmlExportOptions.UseMsoSpace">
|
|
<summary>
|
|
Gets or sets a switch that determines whether to use mso rules' space..
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Hyperlink">
|
|
<summary>
|
|
Represents a hyperlink that can be used to navigate to a specific URL.
|
|
Implements the IDisposable interface to ensure proper cleanup of resources.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.FilePath">
|
|
<summary>
|
|
Gets or sets file path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.Uri">
|
|
<summary>
|
|
Returns or sets url link.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.BookmarkName">
|
|
<summary>
|
|
Returns or sets bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.Type">
|
|
<summary>
|
|
Returns or sets a HyperlinkType object that indicates the link type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.TextToDisplay">
|
|
<summary>
|
|
Gets or sets the specified hyperlink's visible text in a document.
|
|
</summary>
|
|
<value>The text to display.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyperlink.PictureToDisplay">
|
|
<summary>
|
|
Gets or sets the image which will be displayed on the place of hyperlink.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Hyperlink.#ctor(Spire.Doc.Fields.Field)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Hyperlink"/> class.
|
|
</summary>
|
|
<param name="hyperlink">The hyperlink.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Hyperlink.Dispose">
|
|
<summary>
|
|
Releases all resources used by the current instance of the <see cref="T:Spire.Doc.Hyperlink"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.OwnerHolder">
|
|
<summary>
|
|
Represents an abstract class for holding an owner.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OwnerHolder.Document">
|
|
<summary>
|
|
Gets the document.
|
|
</summary>
|
|
<returns>The document.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.OwnerHolder.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.OwnerHolder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OwnerHolder.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.OwnerHolder"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.OwnerHolder.#ctor(Spire.Doc.Document,Spire.Doc.OwnerHolder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.OwnerHolder"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="owner">The owner.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Permission">
|
|
<summary>
|
|
Represents editable range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Permission.Id">
|
|
<summary>
|
|
Gets permission id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Permission.EditorGroup">
|
|
<summary>
|
|
Gets permission editorgroup.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Permission.PermissionStart">
|
|
<summary>
|
|
Gets the Permission start.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Permission.PermissionEnd">
|
|
<summary>
|
|
Gets the Permission end.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Permission.#ctor(Spire.Doc.PermissionStart)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:Perm"/> class.
|
|
</summary>
|
|
<param name="start">The start.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Permission.#ctor(Spire.Doc.PermissionStart,Spire.Doc.PermissionEnd)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:Perm"/> class.
|
|
</summary>
|
|
<param name="start">The Permission start.</param>
|
|
<param name="end">The Permission end.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.PictureWatermark">
|
|
<summary>
|
|
Represents a picture watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PictureWatermark.Scaling">
|
|
<summary>
|
|
Gets or sets picture scaling in percents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PictureWatermark.IsWashout">
|
|
<summary>
|
|
Gets or sets washout property for Picture watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PictureWatermark.Picture">
|
|
<summary>
|
|
Gets or sets the picture associated with the object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PictureWatermark.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.PictureWatermark"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PictureWatermark.#ctor(System.Drawing.Image,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the PictureWatermark class with the specified image and washout option.
|
|
</summary>
|
|
<param name="image">The image to use as the watermark.</param>
|
|
<param name="washout">A boolean indicating whether the watermark should be washed out (i.e., semi-transparent).</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PictureWatermark.SetPicture(System.String)">
|
|
<summary>
|
|
Sets the picture.
|
|
</summary>
|
|
<param name="ImgFile">The image file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PictureWatermark.SetPicture(System.IO.Stream)">
|
|
<summary>
|
|
Sets the picture.
|
|
</summary>
|
|
<param name="imgStream">The img stream.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.MailMergeMainDocumentType">
|
|
<summary>
|
|
Specifies the possible types for a mail merge source document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.NotAMergeDocument">
|
|
<summary>
|
|
This document is not a mail merge document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.FormLetters">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the form letter type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.MailingLabels">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the mailing label type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.Envelopes">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the envelope type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.Catalog">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the catalog type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.Email">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the e-mail message type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.Fax">
|
|
<summary>
|
|
Specifies that the mail merge source document is of the fax type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.MailMergeMainDocumentType.Default">
|
|
<summary>
|
|
Equals to <see cref="F:Spire.Doc.MailMergeMainDocumentType.NotAMergeDocument"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.OdsoRecipientData">
|
|
<summary>
|
|
Represents information about a single record within an external data source that is to be excluded from the mail merge.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientData.#ctor">
|
|
<summary>
|
|
Initializes a new instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientData.Clone">
|
|
<summary>
|
|
Returns a deep clone of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientData.Active">
|
|
<summary>
|
|
Specifies whether the record from the data source shall be imported into a document when the mail merge is performed.
|
|
The default value is <c>true</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientData.Column">
|
|
<summary>
|
|
Specifies the column within the data source that contains unique data for the current record.
|
|
The default value is 0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientData.UniqueTag">
|
|
<summary>
|
|
Specifies the contents of a given record in the column containing unique data.
|
|
The default value is <c>null</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientData.Hash">
|
|
<summary>
|
|
Represents the hash code for this record.
|
|
Sometimes Microsoft Word uses <see cref="P:Spire.Doc.OdsoRecipientData.Hash"/> of a whole record instead of a <see cref="P:Spire.Doc.OdsoRecipientData.UniqueTag"/> value.
|
|
The default value is 0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.OdsoRecipientDataCollection">
|
|
<summary>
|
|
A typed collection of <see cref="T:Spire.Doc.OdsoRecipientData"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientDataCollection.#ctor">
|
|
<summary>
|
|
Initializes a new instance of this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientDataCollection.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.OdsoRecipientDataCollection.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets an item in this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientDataCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an <ms>enumerator</ms><java>iterator</java> object that can be used to iterate over all items in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientDataCollection.Add(Spire.Doc.OdsoRecipientData)">
|
|
<summary>
|
|
Adds an object to the end of this collection.
|
|
</summary>
|
|
<param name="value">The object to add. Cannot be null.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientDataCollection.Clear">
|
|
<summary>
|
|
Removes all elements from this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.OdsoRecipientDataCollection.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the element at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the element.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentProperties">
|
|
<summary>
|
|
Class DocumentProperties of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperties.FormFieldShading">
|
|
<summary>
|
|
Specifies whether to apply shading on form fields.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentProperties.Version">
|
|
<summary>
|
|
Gets the document version.
|
|
</summary>
|
|
<value>The version.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Author">
|
|
<summary>
|
|
Gets or sets author name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.ApplicationName">
|
|
<summary>
|
|
Gets or sets application name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Title">
|
|
<summary>
|
|
Gets or sets the document title
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Subject">
|
|
<summary>
|
|
Gets or sets the subject of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Keywords">
|
|
<summary>
|
|
Gets or sets the document keywords
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Comments">
|
|
<summary>
|
|
Gets or sets the comments that provide additional information about the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Template">
|
|
<summary>
|
|
Gets or sets the template name of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.LastAuthor">
|
|
<summary>
|
|
Gets or sets the last author name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.RevisionNumber">
|
|
<summary>
|
|
Gets or sets the document revision number
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.TotalEditingTime">
|
|
<summary>
|
|
Gets or sets the document total editing time
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.LastPrinted">
|
|
<summary>
|
|
Returns or sets the last print date
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.CreateDate">
|
|
<summary>
|
|
Gets or sets the document creation date
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.LastSaveDate">
|
|
<summary>
|
|
Returns or sets the last save date
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.PageCount">
|
|
<summary>
|
|
Gets document pages count
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.WordCount">
|
|
<summary>
|
|
Gets document words count
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.CharCount">
|
|
<summary>
|
|
Gets document characters count
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.CharCountWithSpace">
|
|
<summary>
|
|
Gets document characters count(including spaces)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Thumbnail">
|
|
<summary>
|
|
Returns or setsthumbnail picture for document preview
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.DocSecurity">
|
|
<summary>
|
|
Gets or sets document security level
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SummaryDocumentProperties.Count">
|
|
<summary>
|
|
Gets summary count of document properties
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.SummaryDocumentProperties.Add(System.Int32,Spire.Doc.DocumentProperty)">
|
|
<summary>
|
|
Adds the specified name.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Tab">
|
|
<summary>
|
|
Represents tab stop.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Tab.Justification">
|
|
<summary>
|
|
Gets or sets the justification.
|
|
</summary>
|
|
<value>The justification.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Tab.TabLeader">
|
|
<summary>
|
|
Gets or sets the tab leader.
|
|
</summary>
|
|
<value>The tab leader.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Tab.Position">
|
|
<summary>
|
|
Gets or sets the position.
|
|
</summary>
|
|
<value>The position.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Tab.Equals(Spire.Doc.Tab)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:Spire.Doc.Tab"/> is equal to the current <see cref="T:Spire.Doc.Tab"/>.
|
|
</summary>
|
|
<param name="tab">The <see cref="T:Spire.Doc.Tab"/> to compare with the current <see cref="T:Spire.Doc.Tab"/>.</param>
|
|
<returns><c>true</c> if the specified <see cref="T:Spire.Doc.Tab"/> is equal to the current <see cref="T:Spire.Doc.Tab"/>; otherwise, <c>false</c>.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.OwnerTextBody">
|
|
<summary>
|
|
Gets the owner text body.
|
|
</summary>
|
|
<value>The owner text body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.IsInsertRevision">
|
|
<summary>
|
|
Gets a value indicating whether this item was inserted to the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.InsertRevision">
|
|
<summary>
|
|
Gets the insert revision for this objects.
|
|
Note this can be null. If null does not have insert revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.IsDeleteRevision">
|
|
<summary>
|
|
Gets a value indicating whether this item was deleted from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.DeleteRevision">
|
|
<summary>
|
|
Gets the delete revision for this objects.
|
|
Note this can be null. If null does not have delete revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.IsMoveFromRevision">
|
|
<summary>
|
|
Gets a value indicating whether this item was MoveFrom from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.MoveFromRevision">
|
|
<summary>
|
|
Gets the MoveFrom revision for this objects.
|
|
Note this can be null. If null does not have delete revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.IsMoveToRevision">
|
|
<summary>
|
|
Gets a value indicating whether this item was MoveTo from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BodyRegion.MoveToRevision">
|
|
<summary>
|
|
Gets the MoveTo revision for this objects.
|
|
Note this can be null. If null does not have delete revision.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.BodyRegion"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.Find(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds text by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern">Pattern</param>
|
|
<param name="newValue">Replace text</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces by specified matchString string.
|
|
</summary>
|
|
<param name="matchString">The matchString text.</param>
|
|
<param name="newValue">The newValue text.</param>
|
|
<param name="caseSensitive">if set to <c>true</c> case sensitive newValue.</param>
|
|
<param name="wholeWord">if it replaces only whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.BodyRegion.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection,System.Boolean)">
|
|
<summary>
|
|
Replaces by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="saveFormatting">if save source formatting, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.TextWatermark">
|
|
<summary>
|
|
Represents a text watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.Text">
|
|
<summary>
|
|
Gets or sets watermark text
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.FontName">
|
|
<summary>
|
|
Gets or sets watermark text's font name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.FontSize">
|
|
<summary>
|
|
Gets or sets text watermark size.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.Color">
|
|
<summary>
|
|
Gets or sets text watermark color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.Semitransparent">
|
|
<summary>
|
|
Gets or sets semitransparent property for Text watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TextWatermark.Layout">
|
|
<summary>
|
|
Gets or sets layout for Text watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.TextWatermark.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.TextWatermark"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.TextWatermark.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.TextWatermark"/> class.
|
|
</summary>
|
|
<param name="text">WatermarkBase text</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.TextWatermark.#ctor(System.String,System.String,System.Int32,Spire.Doc.Documents.WatermarkLayout)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.TextWatermark"/> class.
|
|
</summary>
|
|
<param name="text">WatermarkBase text</param>
|
|
<param name="fontName">Text font name</param>
|
|
<param name="fontSize">Font size</param>
|
|
<param name="layout">WatermarkBase layout</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.VariableCollection">
|
|
<summary>
|
|
Represents a collection of variables that implements the IEnumerable interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.VariableCollection.Item(System.String)">
|
|
<summary>
|
|
Gets or sets the variable with the specified name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.VariableCollection.Count">
|
|
<summary>
|
|
Gets the count of variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.VariableCollection"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.Add(System.String,System.String)">
|
|
<summary>
|
|
Adds variable to document.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.GetNameByIndex(System.Int32)">
|
|
<summary>
|
|
Gets variable's key by the index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.GetValueByIndex(System.Int32)">
|
|
<summary>
|
|
Gets variable's value by the index.
|
|
</summary>
|
|
<param name="index">The index.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.Remove(System.String)">
|
|
<summary>
|
|
Removes document variable with specified name from the document.
|
|
</summary>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.VariableCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>An IEnumerator object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.WatermarkBase">
|
|
<summary>
|
|
Represents the base class for watermark objects in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.WatermarkBase.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.WatermarkBase.Type">
|
|
<summary>
|
|
Gets the watermark type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.HeadersFooters">
|
|
<summary>
|
|
Represents the headers and footers of a document.
|
|
Implements the DocumentSerializable interface for serialization capabilities and IEnumerable for iteration over its elements.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.Header">
|
|
<summary>
|
|
Gets default header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.Footer">
|
|
<summary>
|
|
Gets default footer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.EvenHeader">
|
|
<summary>
|
|
Gets even header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.OddHeader">
|
|
<summary>
|
|
Gets odd header ( This is also the default header ).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.EvenFooter">
|
|
<summary>
|
|
Gets even footer
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.OddFooter">
|
|
<summary>
|
|
Gets odd footer ( This is also the default footer ).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.FirstPageHeader">
|
|
<summary>
|
|
Gets first page header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.FirstPageFooter">
|
|
<summary>
|
|
Gets first page footer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.IsEmpty">
|
|
<summary>
|
|
Detects whether all headers/footers are empty.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.Item(System.Int32)">
|
|
<summary>
|
|
Gets TextBody at specified index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.Item(Spire.Doc.Documents.HeaderFooterType)">
|
|
<summary>
|
|
Gets TextBody by specified HeaderFooter type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeadersFooters.LinkToPrevious">
|
|
<summary>
|
|
If set to True if this header or footer is linked in the previous section.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.HeadersFooters.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.HeaderFooter">
|
|
<summary>
|
|
Represents a header or footer in a document, inheriting from the Body class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeaderFooter.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.HeaderFooter.LinkToPrevious">
|
|
<summary>
|
|
If set to True if this header/footer is linked to the header/footer in the previous section.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentBase.#ctor(Spire.Doc.Document,Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.DocumentBase"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="owner">The owner.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentContainer">
|
|
<summary>
|
|
Represents a container for documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DocumentContainer.Count">
|
|
<summary>
|
|
Gets count of child object.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentContainer.#ctor(Spire.Doc.Document,Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.DocumentContainer"/> class.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
<param name="owner">The owner.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.DocumentContainer.GetIndex(Spire.Doc.Interface.IDocumentObject)">
|
|
<summary>
|
|
Returns the zero-based index of the specified entity.
|
|
</summary>
|
|
<param name="entity">the document object.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.UseNewEngine">
|
|
<summary>
|
|
Gets a value indicating whether the new engine layout is enabled.
|
|
The Spire.Doc product conversion feature has enabled the new engine way layout by default.
|
|
If you want to switch to the old engine layout, use the Document constructor
|
|
with the \"useNewEngine\" parameter and set the parameter \"useNewEngine\" to false.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.EvalInformation">
|
|
<summary>
|
|
Get Spire.Doc Eval version limit information.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Document.HtmlUrlLoadHandler">
|
|
<summary>
|
|
Represents a method that will handle the HtmlUrlLoad event, providing the sender and event arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Document.HtmlUrlLoadEventArgs">
|
|
<summary>
|
|
Provides data for the HtmlUrlLoad event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HtmlUrlLoadEventArgs.Url">
|
|
<summary>
|
|
Gets or sets the URL.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HtmlUrlLoadEventArgs.DataBytes">
|
|
<summary>
|
|
Gets or sets the data bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.HtmlUrlLoadEvent">
|
|
<summary>
|
|
Occurs when download a web source.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.BookmarkLayout">
|
|
<summary>
|
|
Occurs when draw a bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.PageLayout">
|
|
<summary>
|
|
Occurs when creating a new page.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.PageImagePainted">
|
|
<summary>
|
|
Occurs when creating a new Image painted
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Document.UpdateFields">
|
|
<summary>
|
|
Occurs when update field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.TOC">
|
|
<summary>
|
|
Gets or sets the TOC element of the word document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.PrivateFontList">
|
|
<summary>
|
|
Gets the private font list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.EmbedFontsInFile">
|
|
<summary>
|
|
Gets or sets a value indicating whether save fonts that are used in the document in the file.
|
|
Only support for the DOCX file format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.EmbedSystemFonts">
|
|
<summary>
|
|
Gets or sets a value indicating whether save system fonts that are used in the document in the file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HtmlBaseUrl">
|
|
<summary>
|
|
Gets or sets the Base path which is used to convert the relative path to absolute path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HTMLTrackChanges">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether parsing and writing custom Change_Tracking HTML Tags are supported.</para>
|
|
<para>Supported HTML Tag : insert / delete.</para>
|
|
<para>Supported HTML Tag Attribytes : data-username / data-time.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HTMLSentenceIdentifier">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether to add identifier to a sentence when writing to HTML.</para>
|
|
<para>Writed HTML Attribyte : sentence.</para>
|
|
<para>Writed HTML Value Of Attribyte : start / end / (start,end).</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HTMLCustomComment">
|
|
<summary>
|
|
<para>Gets or sets a value specifying whether parsing and writing comment of document in HTML.</para>
|
|
<para>Supported HTML Tag : span ,when the value of class attribute is comment</para>
|
|
<para>Supported HTML Tag Attribytes : data-comment / data-user / data-cid / data-date.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HTMLIdentifierPunctuations">
|
|
<summary>
|
|
Set the custom punctuation as sentence indentifier.
|
|
Full stop, qusetion mark, exclamatory mark are default values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Footnotes">
|
|
<summary>
|
|
Gets document footnotes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Endnotes">
|
|
<summary>
|
|
Gets document endnotes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.BuiltinDocumentProperties">
|
|
<summary>
|
|
Gets document built-in properties object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.CustomDocumentProperties">
|
|
<summary>
|
|
Gets document custom properties object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Sections">
|
|
<summary>
|
|
Gets document sections.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Styles">
|
|
<summary>
|
|
Gets the styles of documnet.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ListReferences">
|
|
<summary>
|
|
Gets the list references of document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Bookmarks">
|
|
<summary>
|
|
Gets document bookmarks.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Fields">
|
|
<summary>
|
|
Gets fields of the documnet.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Comments">
|
|
<summary>
|
|
Gets comments item of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.TextBoxes">
|
|
<summary>
|
|
Get/set textbox items of main document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.LastSection">
|
|
<summary>
|
|
Gets last section of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.LastParagraph">
|
|
<summary>
|
|
Gets last section object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.EndnoteOptions">
|
|
<summary>
|
|
Gets or sets options that control numbering and positioning of endnotes in this document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.FootnoteOptions">
|
|
<summary>
|
|
Gets or sets options that control numbering and positioning of footnotes in this document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Watermark">
|
|
<summary>
|
|
Gets or sets document's watermark.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetWatermark(Spire.Doc.PictureWatermark,System.Int32)">
|
|
<summary>
|
|
Sets a picture watermark for the specified section.
|
|
</summary>
|
|
<param name="value">The PictureWatermark object to set as the watermark.</param>
|
|
<param name="sectionIndex">The index of the section where the watermark will be applied.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.HasDigitalSignature(System.String)">
|
|
<summary>
|
|
Verifies the presence of a digital signature in the specified Doc/Docx file.
|
|
</summary>
|
|
<param name="filename">The Doc/Docx filename.</param>
|
|
<returns>True if exists; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.HasDigitalSignature(System.IO.Stream)">
|
|
<summary>
|
|
Verifies the presence of a digital signature in the specified Doc/Docx stream.
|
|
</summary>
|
|
<param name="stream">The Doc/Docx stream.</param>
|
|
<returns>True if exists; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.DigitalSignatures">
|
|
<summary>
|
|
Gets the collection of digital signatures in the current document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Background">
|
|
<summary>
|
|
Gets document's background
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.MailMerge">
|
|
<summary>
|
|
Gets mail merge engine.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ProtectionType">
|
|
<summary>
|
|
Gets or sets the type of protection of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ViewSetup">
|
|
<summary>
|
|
Gets view setup options in Microsoft word.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.QuiteMode">
|
|
<summary>
|
|
Gets or sets whether is quite mode.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.XHTMLValidateOption">
|
|
<summary>
|
|
Gets or sets the HTML validate option.the default value is None.
|
|
</summary>
|
|
<value>The HTML validate option.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Variables">
|
|
<summary>
|
|
Gets or sets the document variables.
|
|
</summary>
|
|
<value>The variables.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.Properties">
|
|
<summary>
|
|
Gets the document properties.
|
|
</summary>
|
|
<value>The properties.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HasChanges">
|
|
<summary>
|
|
Gets a value indicating whether the document has tracked changes.
|
|
</summary>
|
|
<value>
|
|
if the document has tracked changes, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.TrackChanges">
|
|
<summary>
|
|
Gets or sets a value that determines whether changes are tracked
|
|
when the document is edited in applications like Microsoft Word or WPS.
|
|
</summary>
|
|
<remarks>
|
|
The property only controls whether the track changes is enabled in applications
|
|
like Microsoft Word or WPS. It has no effect on changes to the document that you
|
|
make programmatically via Spire.Doc.If you want to programmatically track changes
|
|
as they are made by Spire.Doc, please use the StartTrackRevisions method.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.AutoUpdateStylesByTemplate">
|
|
<summary>
|
|
Gets or sets a value indicating whether updating the styles in this document to match
|
|
the styles in the attached template each time you open .
|
|
</summary>
|
|
<value>if update document styles automatically, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ReplaceFirst">
|
|
<summary>
|
|
Gets or sets a value indicating whether need first replacing.
|
|
</summary>
|
|
<value>True indciates need first replacing.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.HtmlExportOptions">
|
|
<summary>
|
|
Gets the Html save options.
|
|
</summary>
|
|
<value>The save options.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.MarkdownExportOptions">
|
|
<summary>
|
|
Gets the Markdown save options.
|
|
</summary>
|
|
<value>The save options.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.IsUpdateFields">
|
|
<summary>
|
|
Gets or sets a value indicating whether to update fields in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.DetectedFormatType">
|
|
<summary>
|
|
Returns the detected format type of the document which was loaded. .
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.JPEGQuality">
|
|
<summary>
|
|
Gets/sets the quality (Q%) of the image of JPEG format, this property
|
|
is only used for doc to pdf. The default value is 80.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.PageCount">
|
|
<summary>
|
|
Gets total number of pages for document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.PrintDocument">
|
|
<summary>
|
|
Gets the PrintDocument
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.IsContainMacro">
|
|
<summary>
|
|
Indicates whether the document has macros.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.KeepSameFormat">
|
|
<summary>
|
|
Gets or sets a value that indicates whether to keep same formatting when this document is merged to other document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from Word document.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified file name and engine usage flag.
|
|
</summary>
|
|
<param name="fileName">The name of the document file.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from existing Word document,
|
|
which is protected with password.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified file name, password, and engine usage.
|
|
</summary>
|
|
<param name="fileName">The name of the document file.</param>
|
|
<param name="password">The password required to open the document.</param>
|
|
<param name="useNewEngine">Indicates whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Document"/> class.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="type">The type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified file name, file format, and flag indicating whether to use the new engine.
|
|
</summary>
|
|
<param name="fileName">The name of the file to open or create.</param>
|
|
<param name="type">The format of the file.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Document"/> class.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="type">The type of the opened document.</param>
|
|
<param name="validationType">The XHTML validation type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified file name, file format, XHTML validation type, and flag indicating whether to use the new engine.
|
|
</summary>
|
|
<param name="fileName">The name of the document file.</param>
|
|
<param name="type">The file format of the document.</param>
|
|
<param name="validationType">The XHTML validation type to use.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from
|
|
existing file of specified type protected with password.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="type">The type.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.String,Spire.Doc.FileFormat,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified file name, file format, password, and whether to use the new engine.
|
|
</summary>
|
|
<param name="fileName">The name of the document file.</param>
|
|
<param name="type">The file format of the document.</param>
|
|
<param name="password">The password required to open the document, if any.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Initializes a new instance of the Document class
|
|
</summary>
|
|
<param name="stream">The file stream.</param>
|
|
<param name="type">The type of the opened document.</param>
|
|
<param name="validationType">Type of the validation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified stream, file format, XHTML validation type, and use new engine flag.
|
|
</summary>
|
|
<param name="stream">The stream containing the document data.</param>
|
|
<param name="type">The file format of the document.</param>
|
|
<param name="validationType">The XHTML validation type to be used.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Document"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Document"/> class.
|
|
</summary>
|
|
<param name="useNewEngine">Use new engine.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from the stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class using the specified stream and engine settings.
|
|
</summary>
|
|
<param name="stream">The stream to use for reading the document.</param>
|
|
<param name="useNewEngine">A boolean indicating whether to use the new engine.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from the stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified stream, file format, and engine usage.
|
|
</summary>
|
|
<param name="stream">The stream containing the document data.</param>
|
|
<param name="type">The file format of the document.</param>
|
|
<param name="useNewEngine">Indicates whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the Document class from the Word document stream,
|
|
which is protected with password.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified stream, password, and engine usage.
|
|
</summary>
|
|
<param name="stream">The stream to load the document from.</param>
|
|
<param name="password">The password to use for opening the document.</param>
|
|
<param name="useNewEngine">Indicates whether to use the new engine for processing the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the Document class
|
|
from the stream of specified type protected with password.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="type">The type.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.#ctor(System.IO.Stream,Spire.Doc.FileFormat,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the Document class with the specified stream, file format, password, and new engine option.
|
|
</summary>
|
|
<param name="stream">The stream to load the document from.</param>
|
|
<param name="type">The file format of the document.</param>
|
|
<param name="password">The password to open the document, if encrypted.</param>
|
|
<param name="useNewEngine">Indicates whether to use the new rendering engine for the document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CreateParagraph">
|
|
<summary>
|
|
Creates the paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CreateMinialDocument">
|
|
<summary>
|
|
Create a minial document, one empty section to the document and one empty paragraph to created section.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.AddSection">
|
|
<summary>
|
|
Adds new section to document.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.AddParagraphStyle(System.String)">
|
|
<summary>
|
|
Adds new paragraph style to the document.
|
|
</summary>
|
|
<param name="styleName">Paragraph style name</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.AddListDefinitionReference(Spire.Doc.Documents.ListType,System.String)">
|
|
<summary>
|
|
Adds a list definition reference using the specified list type and name.
|
|
</summary>
|
|
<param name="listType">The type of list (numbered or bullet).</param>
|
|
<param name="listName">The name of the list.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.GetText">
|
|
<summary>
|
|
Gets the document's text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Sign(System.IO.Stream,System.String,System.String)">
|
|
<summary>
|
|
Create digitally signed word document.
|
|
Digital signature of documents support only DOC and DOCX formats.
|
|
</summary>
|
|
<param name="sourceStream">Source file stream</param>
|
|
<param name="certificatePath">Path to the file certificate</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
<returns>Bytes of signed word document </returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Sign(System.IO.Stream,System.Byte[],System.String)">
|
|
<summary>
|
|
Create digitally signed word document.
|
|
Digital signature of documents support only DOC and DOCX formats.
|
|
</summary>
|
|
<param name="sourceStream">Source file stream.</param>
|
|
<param name="certificateData">the certificate data.</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
<returns>Bytes of signed word document</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Clone">
|
|
<summary>
|
|
Clones itself.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.IntegrateFontTableTo(Spire.Doc.Document)">
|
|
<summary>
|
|
Integrate the current document font table to the destination document.
|
|
</summary>
|
|
<param name="destDoc">The destination document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CloneDefaultStyleTo(Spire.Doc.Document)">
|
|
<summary>
|
|
Clones the current document default style to the destination document.
|
|
</summary>
|
|
<param name="destDoc">The destination document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CloneThemesTo(Spire.Doc.Document)">
|
|
<summary>
|
|
Clones the current document theme style to the destination document.
|
|
</summary>
|
|
<param name="destDoc">The destination document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CloneCompatibilityTo(Spire.Doc.Document)">
|
|
<summary>
|
|
Clones the current document compatibility to the destination document.
|
|
</summary>
|
|
<param name="destDoc">The destination document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ImportSection(Spire.Doc.Interface.ISection)">
|
|
<summary>
|
|
Imports section into document.
|
|
</summary>
|
|
<param name="section">The section.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ImportContent(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Imports all content into the document.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ImportContent(Spire.Doc.Interface.IDocument,System.Boolean)">
|
|
<summary>
|
|
Imports all content into document.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="importStyles">If document styles which have same names will be also imported
|
|
to the destination document,set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.AddStyle(Spire.Doc.Documents.BuiltinStyle)">
|
|
<summary>
|
|
Adds the style to the document style.
|
|
</summary>
|
|
<param name="builtinStyle">The built-in style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.AcceptChanges">
|
|
<summary>
|
|
Accepts changes tracked from the moment of last change acceptance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.RejectChanges">
|
|
<summary>
|
|
Rejects changes tracked from the moment of last change acceptance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CheckProtectionPassWord(System.String)">
|
|
<summary>
|
|
Check that the password entered is the same as the permission protection password
|
|
</summary>
|
|
<param name="password">The enter password</param>
|
|
<returns>whether the password entered is the same as the permission protection password</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Protect(Spire.Doc.ProtectionType)">
|
|
<summary>
|
|
Protects the document.
|
|
</summary>
|
|
<param name="type">The type of the protection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Protect(Spire.Doc.ProtectionType,System.String)">
|
|
<summary>
|
|
Protects the document.
|
|
</summary>
|
|
<param name="type">The type of the protection</param>
|
|
<param name="password">The password used for protection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Unprotect">
|
|
<summary>
|
|
Unprotect the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Unprotect(System.String)">
|
|
<summary>
|
|
Unprotect the document with a password.
|
|
</summary>
|
|
<param name="password">The password.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetWriteProtection(System.String)">
|
|
<summary>
|
|
Sets the write protection for a document using the provided password.
|
|
</summary>
|
|
<param name="password">The password to set for write protection.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetWriteProtection(System.String,System.Boolean)">
|
|
<summary>
|
|
Sets the write protection for a document with an optional password and recommended read-only setting.
|
|
</summary>
|
|
<param name="password">The password to set for write protection.</param>
|
|
<param name="recommended">Whether the read-only recommendation should be enabled (true) or disabled (false).</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UnWriteProtection">
|
|
<summary>
|
|
Removes the write protection from a document by clearing the password and disabling the read-only recommendation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UnWriteProtection(System.String)">
|
|
<summary>
|
|
Attempts to remove the write protection from a document by validating the provided password and, if valid, clearing the password and disabling the read-only recommendation.
|
|
</summary>
|
|
<param name="password">The password used for write protection.</param>
|
|
<returns>True if the password is valid and the write protection was successfully removed, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.HasWriteProtection">
|
|
<summary>
|
|
Checks if the document has write protection.
|
|
</summary>
|
|
<returns>True if the document has write protection, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Encrypt(System.String)">
|
|
<summary>
|
|
Encrypts the document.
|
|
</summary>
|
|
<param name="password">Password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.RemoveEncryption">
|
|
<summary>
|
|
Removes the encryption.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.IsEncrypted(System.String)">
|
|
<summary>
|
|
Check that the document is encrypted
|
|
</summary>
|
|
<param name="fileName">The file name</param>
|
|
<returns>whether the document is encrypted.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.IsEncrypted(System.IO.Stream)">
|
|
<summary>
|
|
Check that the document is encrypted
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<returns>whether the document is encrypted.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToTxt(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Saves to text document with specified encoding.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="encoding">The encoding.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadHTML(System.IO.TextReader,System.String,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Load document in html format
|
|
</summary>
|
|
<param name="reader">Reader of html code.</param>
|
|
<param name="baseURL">The default base URL for all links of external resource,
|
|
it should be a absolute and well formed uri string, for example:
|
|
http://www.e-iceblue.com/ or file:///C:/mywebsite/docs/
|
|
If it's null, use the href attribute of base tag in html instead;
|
|
Otherwise, it will overwrite the href attribute of base tag.</param>
|
|
<param name="validationType">XHTML validation type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadHTML(System.IO.TextReader,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Load document in html format
|
|
</summary>
|
|
<param name="reader">Reader of html code.</param>
|
|
<param name="validationType">XHTML validation type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadText(System.String)">
|
|
<summary>
|
|
Opens the text document from a file with default encoding utf-8.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadText(System.IO.Stream)">
|
|
<summary>
|
|
Opens the text document from a stream with default encoding utf-8.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadText(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Opens the text document with specified encoding from a file.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="encoding">The encoding</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadText(System.IO.Stream,System.Text.Encoding)">
|
|
<summary>
|
|
Opens the text document with specified encoding from a stream.
|
|
</summary>
|
|
<param name="stream">The text document stream.</param>
|
|
<param name="encoding">The encoding</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadText(System.IO.TextReader)">
|
|
<summary>
|
|
Opens the rtf document with specified encoding from a reader.
|
|
</summary>
|
|
<param name="reader">The rtf document reader</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromFile(System.String)">
|
|
<summary>
|
|
Opens doc file.
|
|
</summary>
|
|
<param name="fileName"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromFile(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Opens the document from file in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName"></param>
|
|
<param name="formatType"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromFile(System.String,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Opens the HTML document from stream .
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="formatType">Type of the format.</param>
|
|
<param name="validationType">Type of the validation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromFile(System.String,Spire.Doc.FileFormat,System.String)">
|
|
<summary>
|
|
Opens the document from file in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="formatType">Type of the format.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromFileInReadMode(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
LoadFromStream new document in read-only mode.
|
|
</summary>
|
|
<param name="strFileName">File to open.</param>
|
|
<param name="fileFormat">Type of the format.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadRtf(System.String)">
|
|
<summary>
|
|
Opens the rtf document from a file.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadRtf(System.IO.Stream)">
|
|
<summary>
|
|
Opens the rtf document from a stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadRtf(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Opens the rtf document with specified encoding from a file.
|
|
</summary>
|
|
<param name="fileName">Name of the file.</param>
|
|
<param name="encoding">The encoding</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadRtf(System.IO.Stream,System.Text.Encoding)">
|
|
<summary>
|
|
Opens the rtf document with specified encoding from a stream.
|
|
</summary>
|
|
<param name="stream">The rtf document stream.</param>
|
|
<param name="encoding">The encoding</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadRtf(System.IO.TextReader)">
|
|
<summary>
|
|
Opens the rtf document with specified encoding from a reader.
|
|
</summary>
|
|
<param name="reader">The rtf document reader</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.String)">
|
|
<summary>
|
|
Saves to file in Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.String,Spire.Doc.ToPdfParameterList)">
|
|
<summary>
|
|
Saves the document to PDF file.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
<param name="paramList">Parameter list</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToEpub(System.String,Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Saves the EPUB document.
|
|
</summary>
|
|
<param name="fileName">The file name.</param>
|
|
<param name="coverImage">The cover image.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToEpub(System.IO.Stream,Spire.Doc.Fields.DocPicture)">
|
|
<summary>
|
|
Saves the EPUB document.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="coverImage">The cover image.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.InsertTextFromFile(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Insert text from a file.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
<param name="fileFormat">Type of the format</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.InsertTextFromStream(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Insert text from stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="fileFormat">Type of the format</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.String,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Saves the document to file in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="fileName">File name</param>
|
|
<param name="formatType">Type of the format</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveMhtml(System.IO.Stream)">
|
|
<summary>
|
|
Saves the current document as an MHTML file to the specified stream.
|
|
This method includes a license check to ensure the functionality is only available with a valid license.
|
|
It also checks if the evaluation period has expired.
|
|
</summary>
|
|
<param name="stream">The stream to which the MHTML content will be saved.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToSVG(System.String)">
|
|
<summary>
|
|
Saves the SVG.
|
|
</summary>
|
|
<param name="fileName">The file name.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToSVG">
|
|
<summary>
|
|
Saves the SVG.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToStream(System.IO.Stream,Spire.Doc.ToPdfParameterList)">
|
|
<summary>
|
|
Saves the document into stream.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="paramList"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromStream(System.IO.Stream,Spire.Doc.FileFormat,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Opens the HTML document from stream .
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="fileFormat">Type of the format.</param>
|
|
<param name="validationType">Type of the validation.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromStream(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Opens the document from stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="fileFormat"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFromStream(System.IO.Stream,Spire.Doc.FileFormat,System.String)">
|
|
<summary>
|
|
Opens the document from stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="fileFormat">Type of the format.</param>
|
|
<param name="password">The password.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToStream(System.IO.Stream,Spire.Doc.FileFormat,System.String,System.String)">
|
|
<summary>
|
|
Saves document to stream and digitally sign, Only DOC and DOCX are supported.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="fileFormat">The file format.</param>
|
|
<param name="certificatePath">Path to the file certificate</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToStream(System.IO.Stream,Spire.Doc.FileFormat,System.Byte[],System.String)">
|
|
<summary>
|
|
Saves document to stream and digitally sign, Only DOC and DOCX are supported.
|
|
</summary>
|
|
<param name="stream">The stream.</param>
|
|
<param name="fileFormat">The file format.</param>
|
|
<param name="certificateData">The certificate data.</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.String,Spire.Doc.FileFormat,System.String,System.String)">
|
|
<summary>
|
|
Saves document to file and digitally sign, Only DOC and DOCX are supported.
|
|
</summary>
|
|
<param name="fileName">The file.</param>
|
|
<param name="fileFormat">The file format.</param>
|
|
<param name="certificatePath">Path to the file certificate</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.String,Spire.Doc.FileFormat,System.Byte[],System.String)">
|
|
<summary>
|
|
Saves document to file and digitally sign, Only DOC and DOCX are supported.
|
|
</summary>
|
|
<param name="fileName">The file.</param>
|
|
<param name="fileFormat">The file format.</param>
|
|
<param name="certificateData">The certificate data.</param>
|
|
<param name="securePassword">Password of the certificate.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToStream(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Saves the document into stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="fileFormat"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToFile(System.IO.Stream,Spire.Doc.FileFormat)">
|
|
<summary>
|
|
Saves the document into stream in Xml or Microsoft Word format.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="fileFormat"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Close">
|
|
<summary>
|
|
Closes this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Dispose">
|
|
<summary>
|
|
Prerforms application-defined tasks associated with freeing,releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToImages(System.Int32,System.Drawing.Imaging.ImageFormat)">
|
|
<summary>
|
|
Save the specified page into image
|
|
</summary>
|
|
<param name="pageIndex">Page index</param>
|
|
<param name="imageFormat">The ImageFormat</param>
|
|
<returns>Returns the image as stream</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToImages(Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Save the whole document into images
|
|
</summary>
|
|
<param name="type">The ImageType</param>
|
|
<returns>Return the images</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToImages(System.Int32,System.Int32,Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Save the specified range of pages into images
|
|
</summary>
|
|
<param name="pageIndex">Page index (Zero based)</param>
|
|
<param name="pageCount">Number of pages</param>
|
|
<param name="type">The ImageType</param>
|
|
<returns>Return the images</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToImages(System.Int32,Spire.Doc.Documents.ImageType)">
|
|
<summary>
|
|
Save the specified page into image
|
|
</summary>
|
|
<param name="pageIndex">Page index</param>
|
|
<param name="type"> The ImageType</param>
|
|
<returns>Returns the image</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveToImages(Spire.Doc.Documents.ImageType,Spire.Doc.ToImageOption)">
|
|
<summary>
|
|
Save the specified page into image
|
|
</summary>
|
|
<param name="type">The ImageType</param>
|
|
<param name="toImageOption"></param>
|
|
<returns>Returns the image array</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindPattern(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds and returns entry of specified regular expression along with formatting.
|
|
</summary>
|
|
<param name="pattern">regex pattern</param>
|
|
<returns>Found text selection</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindPatternInLine(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the first entry of specified pattern in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindString(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds and returns string along with formatting.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindStringInLine(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the first entry of matchString text in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The string to find.</param>
|
|
<param name="caseSensitive">if set to <c>true</c> use case sensitive search.</param>
|
|
<param name="wholeWord">if it search the whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindAllPattern(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Returns all entries of matchString regex.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindAllPattern(System.Text.RegularExpressions.Regex,System.Boolean)">
|
|
<summary>
|
|
Returns all entries of matchString regex.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
<param name="isAdvancedSearch"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindAllString(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Returns all entries of matchString string, taking into consideration caseSensitive
|
|
and wholeWord options.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern"></param>
|
|
<param name="newValue"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with newValue string, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString"></param>
|
|
<param name="newValue"></param>
|
|
<param name="caseSensitive"></param>
|
|
<param name="wholeWord"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Replace(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString string with TextSelection, taking into
|
|
consideration caseSensitive and wholeWord options.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="caseSensitive">if it is case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with TextRangesHolder.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CloneWebSettingsTo(Spire.Doc.Document)">
|
|
<summary>
|
|
clone Websettings to other document
|
|
</summary>
|
|
<param name="otherDoc">The other doc</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Replace(System.String,Spire.Doc.Interface.IDocument,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces the specified matchString.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="matchDoc">The newValue doc.</param>
|
|
<param name="caseSensitive">if it is case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if specifies whole word,set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateWordCount">
|
|
<summary>
|
|
Update Paragraphs count, Word count and Character count
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateWordCount(System.Char[])">
|
|
<summary>
|
|
Update Paragraphs count, Word count and Character count.
|
|
</summary>
|
|
<param name="splitchar">The word separator. </param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateWordCount(System.Char[],System.Boolean)">
|
|
<summary>
|
|
Update Paragraphs count, Word count and Character count.
|
|
</summary>
|
|
<param name="splitchar">The word separator.</param>
|
|
<param name="includeTbFnEn">The include text boxes,footnotes and endnotes.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.GetPageCount">
|
|
<summary>
|
|
Gets total number of pages for document.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateTableOfContents">
|
|
<summary>
|
|
Update Table of contents in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateTableOfContents(Spire.Doc.Fields.TableOfContent)">
|
|
<summary>
|
|
Update specified Table of content in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateTOCPageNumbers">
|
|
<summary>
|
|
Update Table of contents page numbers in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateTOCPageNumbers(Spire.Doc.Fields.TableOfContent)">
|
|
<summary>
|
|
Update specified Table of content page numbers in the document.
|
|
</summary>
|
|
<param name="toc">specified Table of content</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.StartTrackRevisions(System.String,System.DateTime)">
|
|
<summary>
|
|
Begins making all subsequent changes made to the document programmatically as revisions.
|
|
</summary>
|
|
<param name="author">The author to use for revisions.</param>
|
|
<param name="dateTime">The date and time to use for revisions.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.StartTrackRevisions(System.String)">
|
|
<summary>
|
|
Begins making all subsequent changes made to the document programmatically as revisions.
|
|
</summary>
|
|
<param name="author">The author to use for revisions.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.StopTrackRevisions">
|
|
<summary>
|
|
Stops making changes programmatically as revisions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Compare(Spire.Doc.Document,System.String)">
|
|
<summary>
|
|
Compares this document with another document.
|
|
</summary>
|
|
<param name="document">Document to compare</param>
|
|
<param name="author">The author to use for revisions</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Compare(Spire.Doc.Document,System.String,Spire.Doc.Documents.Comparison.CompareOptions)">
|
|
<summary>
|
|
Compares this document with another document.
|
|
</summary>
|
|
<param name="document">Document to compare</param>
|
|
<param name="author">The author to use for revisions</param>
|
|
<param name="options">The comparison parameter</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Compare(Spire.Doc.Document,System.String,System.DateTime)">
|
|
<summary>
|
|
Compares this document with another document.
|
|
</summary>
|
|
<param name="document">Document to compare</param>
|
|
<param name="author">The author to use for revisions</param>
|
|
<param name="dateTime">The date and time to use for revisions</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.Compare(Spire.Doc.Document,System.String,System.DateTime,Spire.Doc.Documents.Comparison.CompareOptions)">
|
|
<summary>
|
|
Compares this document with another document.
|
|
</summary>
|
|
<param name="document">Document to compare</param>
|
|
<param name="author">The author to use for revisions</param>
|
|
<param name="dateTime">The date and time to use for revisions</param>
|
|
<param name="options">The comparison parameter</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ReplaceInLine(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces all entries of matchString text with newValue text in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<param name="caseSensative">if it specifies case sensative newValue, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies only whole word will be replaced, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ReplaceInLine(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries with specified pattern with newValue text in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="newValue">The newValue.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ReplaceInLine(System.String,Spire.Doc.Documents.TextSelection,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces the matchString text with matchSelection in single-line mode.
|
|
</summary>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="matchSelection">The matchSelection.</param>
|
|
<param name="caseSensitive">if it is case sensitive newValue, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it replaces only whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ReplaceInLine(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces the matchString pattern with matchSelection in single-line mode.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="matchSelection">The matchSelection.</param>
|
|
<returns>The number of performed replaces.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindString(Spire.Doc.BodyRegion,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the next entry of matchString string, taking into consideration caseSensitive
|
|
and wholeWord options.
|
|
</summary>
|
|
<param name="start">Search starts.</param>
|
|
<param name="matchString">The string to find.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive search, set to <c>true</c> .</param>
|
|
<param name="wholeWord">if it search for the whole word, set to <c>true</c> .</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindPattern(Spire.Doc.BodyRegion,System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the next entry of matchString pattern.
|
|
</summary>
|
|
<param name="start">Search starts</param>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindStringInLine(Spire.Doc.BodyRegion,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Finds the next matchString text starting from specified using single-line mode.
|
|
</summary>
|
|
<param name="start">Search start.</param>
|
|
<param name="matchString">The matchString.</param>
|
|
<param name="caseSensitive">if it is case sensitive search, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it search for whole word, set to <c>true</c> .</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.FindPatternInLine(Spire.Doc.BodyRegion,System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds the text which fit the specified pattern starting from start.
|
|
using single-line mode.
|
|
</summary>
|
|
<param name="start">Search start.</param>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ResetFindState">
|
|
<summary>
|
|
Resets the FindPattern.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.CreateParagraphItem(Spire.Doc.Documents.ParagraphItemType)">
|
|
<summary>
|
|
Creates new paragraph item instance.
|
|
</summary>
|
|
<param name="itemType">Paragraph item type</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearCloningContexts">
|
|
<summary>
|
|
Clears the different document cloning context.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearMacros">
|
|
<summary>
|
|
Removes the macros from the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ResetPageLayoutCache">
|
|
<summary>
|
|
Reset the page layout cache data of the new engine.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetCustomFontsFolders(System.String)">
|
|
<summary>
|
|
Sets the path to the folder where the custom font is located.
|
|
</summary>
|
|
<param name="fontPath">the folder path.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetCustomFonts(System.IO.Stream[])">
|
|
<summary>
|
|
Sets the custom font stream array.
|
|
</summary>
|
|
<param name="fontStreamList">The custom font stream array.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearCustomFontsFolders">
|
|
<summary>
|
|
Clear the custom fonts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearCustomFonts">
|
|
<summary>
|
|
Clear the custom fonts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetGlobalCustomFontsFolders(System.String)">
|
|
<summary>
|
|
Sets the path to the folder where the global custom font is located.
|
|
</summary>
|
|
<param name="fontPath">the folder path.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetGlobalCustomFontsFolders(System.IO.Stream[])">
|
|
<summary>
|
|
Sets the global custom font stream array.
|
|
</summary>
|
|
<param name="fontStreamList">The custom font stream array.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SetGlobalCustomFonts(System.IO.Stream[])">
|
|
<summary>
|
|
Sets the global custom font stream array.
|
|
</summary>
|
|
<param name="fontStreamList">The custom font stream array.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.DefaultSubstitutionFontName">
|
|
<summary>
|
|
Gets or Sets the default substitution font Name.
|
|
The default value is "Times New Roman".
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearGlobalCustomFontsFolders">
|
|
<summary>
|
|
Clear the global custom fonts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearGlobalCustomFonts">
|
|
<summary>
|
|
Clear the global custom fonts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.ClearSystemFontCache">
|
|
<summary>
|
|
Clears the memory used by cached system fonts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.LoadFontFallbackRuleSettings(System.String)">
|
|
<summary>
|
|
Load the font fallback rules from the xml
|
|
</summary>
|
|
<param name="fileName">The xml file name</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.SaveFontFallbackRuleSettings(System.String)">
|
|
<summary>
|
|
Save the default font fallback rules to the xml
|
|
</summary>
|
|
<param name="fileName">The xml file name</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.LayoutOptions">
|
|
<summary>
|
|
Gets the layout options.
|
|
The related layout settings are only supported for new engines.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.FieldOptions">
|
|
<summary>
|
|
Gets or sets the options for the field.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdatePageLayout">
|
|
<summary>
|
|
Updates the page layout of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.RenderToScale(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single)">
|
|
<summary>
|
|
Draws a document page at the specified scale into the System.Drawing.Graphics object.
|
|
</summary>
|
|
<param name="pageIndex">The 0-based page index.</param>
|
|
<param name="graphics">The object where to draws to.</param>
|
|
<param name="x">The X coordinate (in world units) of the top left corner of the rendered page.</param>
|
|
<param name="y">The Y coordinate (in world units) of the top left corner of the rendered page.</param>
|
|
<param name="scale"> The scale for rendering the page (1.0 is 100%).</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.RenderToSize(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single,System.Single)">
|
|
<summary>
|
|
Draws a document page at the specified size into the System.Drawing.Graphics object.
|
|
</summary>
|
|
<param name="pageIndex">The 0-based page index.</param>
|
|
<param name="graphics">The object where to render to.</param>
|
|
<param name="x">The X coordinate (in world units) of the top left corner of the rendered page.</param>
|
|
<param name="y">The Y coordinate (in world units) of the top left corner of the rendered page.</param>
|
|
<param name="width">The maximum width (in world units) that can be occupied by the rendered page.</param>
|
|
<param name="height">The maximum height (in world units) that can be occupied by the rendered page.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateTableLayout">
|
|
<summary>
|
|
Update table grid before saving the document when using the new engine.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateListLabels">
|
|
Updates the labels of the list.
|
|
</member>
|
|
<member name="M:Spire.Doc.Document.UpdateParagraphListText">
|
|
<summary>
|
|
Updates the text of bullet or list in a paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Document.ForceTableRelayout">
|
|
<summary>
|
|
Gets or sets a value indicating whether to force a table relayout.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.SpireDocEvalInfo">
|
|
<summary>
|
|
Represents the method that will handle an event that with event data.
|
|
</summary>
|
|
<param name="sender">The source of the event.</param>
|
|
<param name="args">The args that contains event data.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.SpireDocEvalException">
|
|
<summary>
|
|
Class free version exception.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.SpireDocEvalException.Message">
|
|
<summary>
|
|
Gets the message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Hyphenation">
|
|
<summary>
|
|
Class represents Hyphenation settings of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyphenation.AutoHyphenation">
|
|
<summary>
|
|
Specifies whether to hyphenate the document contents automatically.
|
|
</summary>
|
|
<value>if automatically hyphenate the document contents, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyphenation.HyphenateCaps">
|
|
<summary>
|
|
Specifies whether to hyphenate words in ALL CAPITAL LETTERS.
|
|
</summary>
|
|
<value>
|
|
if hyphenate words in ALL CAPITAL LETTERS, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyphenation.HyphenationZone">
|
|
<summary>
|
|
Specifies the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation.
|
|
</summary>
|
|
<value>The hyphenation zone.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Hyphenation.ConsecutiveHyphensLimit">
|
|
<summary>
|
|
Specifies the maximum number of consecutive lines of text that can end with a hyphen.
|
|
</summary>
|
|
<value>The consecutive hyphens limit.</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.Template">
|
|
<summary>
|
|
Class represents Attached tempalte of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Template.Path">
|
|
<summary>
|
|
Gets or sets the path of the attached template.
|
|
</summary>
|
|
<value>The path to attached template document</value>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootnoteBody">
|
|
<summary>
|
|
Represents the body of a footnote in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootnoteBody.Separator">
|
|
<summary>
|
|
Gets or sets the separator.
|
|
</summary>
|
|
<value>The separator.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootnoteBody.ContinuationSeparator">
|
|
<summary>
|
|
Gets or sets the continuation separator.
|
|
</summary>
|
|
<value>The continuation separator.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.FootnoteBody.ContinuationNotice">
|
|
<summary>
|
|
Gets or sets the continuation notice.
|
|
</summary>
|
|
<value>The continuation notice.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.FootnoteBody.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Fields.Footnote" /> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.FootnoteBody.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns>Footnote.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Endnote">
|
|
<summary>
|
|
Represents an endnote in a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Endnote.Separator">
|
|
<summary>
|
|
Gets or sets the separator.
|
|
</summary>
|
|
<value>The separator.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Endnote.ContinuationSeparator">
|
|
<summary>
|
|
Gets or sets the continuation separator.
|
|
</summary>
|
|
<value>The continuation separator.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Endnote.ContinuationNotice">
|
|
<summary>
|
|
Gets or sets the continuation notice.
|
|
</summary>
|
|
<value>The continuation notice.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Endnote.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Endnote" /> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Endnote.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns>Endnote.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.PasswordErrorException">
|
|
<summary>
|
|
Class password error exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PasswordErrorException.#ctor(System.String)">
|
|
<summary>
|
|
Class using the specified error message and a new instance of the class.
|
|
</summary>
|
|
<param name="message">the message.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.PasswordErrorException.Message">
|
|
<summary>
|
|
Gets the message that describes the current exception.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ToImageOption">
|
|
<summary>
|
|
Represents options for converting content to an image format.
|
|
Inherits from ToPdfParameterList to include PDF conversion parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PrivateFontPath">
|
|
<summary>
|
|
the PrivateFontPath struct.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PrivateFontPath.FontPath">
|
|
<summary>
|
|
Gets or sets the path of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PrivateFontPath.FontName">
|
|
<summary>
|
|
Gets or sets the name of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PrivateFontPath.FontStyle">
|
|
<summary>
|
|
Gets of sets the style of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PrivateFontPath.UseArabicConcatenationRules">
|
|
<summary>
|
|
Gets or sets a value indicating whether use arabic concatenation rules. default is true.
|
|
</summary>
|
|
<value><c>true</c> if true use arabic concatenation rules,<c>false</c>.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.PrivateFontPath.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the PrivateFontPath struct.
|
|
</summary>
|
|
<param name="fontName">The font name.</param>
|
|
<param name="fontPath">The font path.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PrivateFontPath.#ctor(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the PrivateFontPath struct.
|
|
</summary>
|
|
<param name="fontName">The font name.</param>
|
|
<param name="fontPath">The font path.</param>
|
|
<param name="useArabicConcatenationRules">Use arabic concatenation rules. default is true.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PrivateFontPath.#ctor(System.String,Spire.Doc.Publics.Drawing.FontStyle,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the PrivateFontPath struct.
|
|
</summary>
|
|
<param name="fontName">The font name.</param>
|
|
<param name="fontStyle">The font style.</param>
|
|
<param name="fontPath">The font path.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PrivateFontPath.#ctor(System.String,Spire.Doc.Publics.Drawing.FontStyle,System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the PrivateFontPath struct.
|
|
</summary>
|
|
<param name="fontName">The font name.</param>
|
|
<param name="fontStyle">The font style.</param>
|
|
<param name="fontPath">The font path.</param>
|
|
<param name="useArabicConcatenationRules">Use arabic concatenation rules. default is true.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.DifferRevisions">
|
|
<summary>
|
|
Class difer revisions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.DifferRevisions.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.DifferRevisions"/> struct.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.DifferRevisions.Dispose">
|
|
<summary>
|
|
Releases all resources used by the current instance of the class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DifferRevisions.DeleteRevisions">
|
|
<summary>
|
|
Gets the delete revisions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.DifferRevisions.InsertRevisions">
|
|
<summary>
|
|
Gets the insert revisions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PageSetup">
|
|
<summary>
|
|
Represents the setup of a page within a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.IsTopGutter">
|
|
<summary>
|
|
Gets or sets the value that determines whether use Top Gutter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.DefaultTabWidth">
|
|
<summary>
|
|
Gets or sets the length of the auto tab.
|
|
</summary>
|
|
<value>The length of the auto tab.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageSize">
|
|
<summary>
|
|
Gets or sets page size in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.Orientation">
|
|
<summary>
|
|
Returns or sets orientation of a page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.VerticalAlignment">
|
|
<summary>
|
|
Gets or setsvertical alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.Margins">
|
|
<summary>
|
|
Gets or sets page margins in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.Gutter">
|
|
<summary>
|
|
Gets or sets extra space added to the margin for document binding in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.HeaderDistance">
|
|
<summary>
|
|
Gets or sets height of header in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.FooterDistance">
|
|
<summary>
|
|
Gets or sets footer height in points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.ClientWidth">
|
|
<summary>
|
|
Gets width of client area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.ClientHeight">
|
|
<summary>
|
|
Gets width of client area.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.DifferentFirstPageHeaderFooter">
|
|
<summary>
|
|
Setting to specify that the current section has a different header/footer for first page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.DifferentOddAndEvenPagesHeaderFooter">
|
|
<summary>
|
|
True if the document has different headers and footers
|
|
for odd-numbered and even-numbered pages.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.LineNumberingRestartMode">
|
|
<summary>
|
|
Returns or sets line numbering mode
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.LineNumberingStep">
|
|
<summary>
|
|
Gets or sets line numbering step
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.LineNumberingStartValue">
|
|
<summary>
|
|
Gets or setsline numbering start value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.LineNumberingDistanceFromText">
|
|
<summary>
|
|
Gets or setsdistance from text in lines numbering
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageBordersApplyType">
|
|
<summary>
|
|
Gets or sets the value that determine on which pages border is applied
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageBorderOffsetFrom">
|
|
<summary>
|
|
Gets or sets the position of page border
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.IsFrontPageBorder">
|
|
<summary>
|
|
Gets or sets a value indicating whether this instance is front page border.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageBorderIncludeHeader">
|
|
<summary>
|
|
Gets or sets a value indicating whether the page border include the header.
|
|
If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageBorderIncludeFooter">
|
|
<summary>
|
|
Gets or sets a value indicating whether the page border include the footer.
|
|
If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrome, then it can be ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.Borders">
|
|
<summary>
|
|
Gets page borders collection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.Bidi">
|
|
<summary>
|
|
Gets or sets whether section contains right-to-left text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.EqualColumnWidth">
|
|
<summary>
|
|
Gets or sets a value indicating whether equal column width.
|
|
</summary>
|
|
<value><c>true</c> if equal column width; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageNumberStyle">
|
|
<summary>
|
|
Gets or sets the page number style.
|
|
</summary>
|
|
<value>The page number style.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.PageStartingNumber">
|
|
<summary>
|
|
Gets or sets the page starting number.
|
|
</summary>
|
|
<value>The page starting number.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.RestartPageNumbering">
|
|
<summary>
|
|
Gets or sets a value indicating whether to restart page numbering.
|
|
</summary>
|
|
<value>
|
|
if restart page numbering, set to <c>true</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.GridType">
|
|
<summary>
|
|
Gets or Sets the grid type of this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.LinesPerPage">
|
|
<summary>
|
|
Gets or sets the number of lines per page in the document grid.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.ColumnsLineBetween">
|
|
<summary>
|
|
Gets or sets the value specifies if a vertical line is draw between each
|
|
of the text columns in the this section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PageSetup.CharacterSpacingControl">
|
|
<summary>
|
|
Character Spacing Control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PageSetup.InsertPageNumbers(System.Boolean,Spire.Doc.Documents.PageNumberAlignment)">
|
|
<summary>
|
|
Inserts the page numbers.
|
|
</summary>
|
|
<param name="fromTopPage">if it specifies the top of page, set to <c>true</c>.</param>
|
|
<param name="horizontalAlignment">The horizontal alignment.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.PageSetup.ToString">
|
|
<summary>
|
|
Returns a string that represents the current object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Section">
|
|
<summary>
|
|
Represents a section of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.Body">
|
|
<summary>
|
|
Gets the section body.
|
|
</summary>
|
|
<value>The body.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.EndnoteOptions">
|
|
<summary>
|
|
Gets or sets options that control numbering and positioning of endnotes in current section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.FootnoteOptions">
|
|
<summary>
|
|
Gets or sets options that control numbering and positioning of footnote in current section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.HeadersFooters">
|
|
<summary>
|
|
Gets headers/footers of current section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.PageSetup">
|
|
<summary>
|
|
Gets page Setup of current section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.Columns">
|
|
<summary>
|
|
Get collection of columns which logically divide page on many.
|
|
printing/publishing areas
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.BreakCode">
|
|
<summary>
|
|
Returns or sets break code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.ChildObjects">
|
|
<summary>
|
|
Gets the child objects.
|
|
</summary>
|
|
<value>The child objects.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.Paragraphs">
|
|
<summary>
|
|
Gets the paragraphs.
|
|
</summary>
|
|
<value>The paragraphs.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.Tables">
|
|
<summary>
|
|
Gets the tables.
|
|
</summary>
|
|
<value>The tables.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.TextDirection">
|
|
<summary>
|
|
Gets or sets the text direction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Section.ProtectForm">
|
|
<summary>
|
|
Gets or sets a value indicating whether protect forms.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Section"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.AddColumn(System.Single,System.Single)">
|
|
<summary>
|
|
Adds new column to the section.
|
|
</summary>
|
|
<param name="width">The width.</param>
|
|
<param name="spacing">The spacing.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.MakeColumnsSameWidth">
|
|
<summary>
|
|
Makes all columns in current section to be of equal width.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.Clone">
|
|
<summary>
|
|
Clones it self.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.CloneSectionPropertiesTo(Spire.Doc.Section)">
|
|
<summary>
|
|
Clones the properties of the current to the destination section.
|
|
</summary>
|
|
<param name="destSection">The destination section.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.AddParagraph">
|
|
<summary>
|
|
Adds the paragraph.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.AddTable">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Section.AddTable(System.Boolean)">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<param name="showBorder">Display table borders.True to display;False does not display. </param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Table">
|
|
<summary>
|
|
Represents a table within a document, inheriting from BodyRegion and implementing ITable and ITableWidget interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.DefaultRowHeight">
|
|
<summary>
|
|
Gets or sets the default row height, the unit of measure is point, 1point = 0.3528 mm
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.DefaultColumnsNumber">
|
|
<summary>
|
|
Gets or sets the default column count of per row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.DefaultColumnWidth">
|
|
<summary>
|
|
Gets or sets the default width of each column.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.ColumnWidth">
|
|
<summary>
|
|
Gets or sets the width of each column.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.Rows">
|
|
<summary>
|
|
Get the table rows
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.TableFormat">
|
|
<summary>
|
|
Gets the table format.
|
|
Please use it after calling the RestCells method.
|
|
</summary>
|
|
<value>The first row format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.Format">
|
|
<summary>
|
|
Gets the table format.
|
|
Please use it after calling the RestCells method.
|
|
</summary>
|
|
<value>The table format.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.PreferredWidth">
|
|
<summary>
|
|
This property specifies the preferred horizontal width of a table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.TableStyleName">
|
|
<summary>
|
|
Gets table style name.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.LastCell">
|
|
<summary>
|
|
Get last cell of the table
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.FirstRow">
|
|
<summary>
|
|
Get first row of the table.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.LastRow">
|
|
<summary>
|
|
Get last row of the table.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.Item(System.Int32,System.Int32)">
|
|
<summary>
|
|
Get table cell by row and column indexes.
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.Width">
|
|
<summary>
|
|
Gets the table width
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.IndentFromLeft">
|
|
<summary>
|
|
Gets or sets indent from left for the table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.Title">
|
|
<summary>
|
|
Gets or sets the table title.
|
|
</summary>
|
|
<value>The title.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Table.TableDescription">
|
|
<summary>
|
|
Gets or sets the table description.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Table"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.#ctor(Spire.Doc.Interface.IDocument,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Table"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="showBorder">if it specifies to show the table border, set to <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.#ctor(Spire.Doc.Interface.IDocument,System.Boolean,System.Single)">
|
|
<summary>
|
|
Initializes a new instance of the Table class with the specified document, border visibility, and line width.
|
|
</summary>
|
|
<param name="doc">The document to which the table belongs.</param>
|
|
<param name="showBorder">A boolean indicating whether the table should display a border.</param>
|
|
<param name="lineWidth">The width of the border lines.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddCaption(System.String,Spire.Doc.CaptionNumberingFormat,Spire.Doc.CaptionPosition)">
|
|
<summary>
|
|
Add Caption for current Table
|
|
</summary>
|
|
<param name="captionPosition"></param>
|
|
<param name="name"></param>
|
|
<param name="format"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ResetCells(System.Int32,System.Int32)">
|
|
<summary>
|
|
Resets rows / columns numbers.
|
|
</summary>
|
|
<param name="rowsNum">The rows number.</param>
|
|
<param name="columnsNum">The columns number.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ResetCells(System.Int32,System.Int32,Spire.Doc.Formatting.RowFormat,System.Single)">
|
|
<summary>
|
|
Resets rows / columns numbers.
|
|
</summary>
|
|
<param name="rowsNum">The rows num.</param>
|
|
<param name="columnsNum">The columns num.</param>
|
|
<param name="format"></param>
|
|
<param name="cellWidth">Width of the cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ApplyStyle(Spire.Doc.Documents.DefaultTableStyle)">
|
|
<summary>
|
|
Applies the built-in table style.
|
|
</summary>
|
|
<param name="builtinStyle">The built-in table style.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ApplyTableStyle">
|
|
<summary>
|
|
Applies the table style properties to table and cell.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddRow">
|
|
<summary>
|
|
Adds a row to table
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddRow(System.Int32)">
|
|
<summary>
|
|
Adds a row to table with copy format from the current last row, and then add columnsNum cells to the new row.
|
|
</summary>
|
|
<param name="columnsNum">The number of the count of the new row, it's must be -1 < columnsNum < 64.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddRow(System.Boolean)">
|
|
<summary>
|
|
Adds new row to table.
|
|
</summary>
|
|
<param name="isCopyFormat"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddRow(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Adds a row to table with copy format option
|
|
</summary>
|
|
<param name="isCopyFormat">Indicates whether copy format from previous row or not</param>
|
|
<param name="autoPopulateCells">if specifies to populate cells automatically, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AddRow(System.Boolean,System.Int32)">
|
|
<summary>
|
|
Adds a row to table with copy format option
|
|
</summary>
|
|
<param name="isCopyFormat">Indicates whether copy format from previous row or not</param>
|
|
<param name="columnsNum">The number of the count of the new row, it's must be -1 < columnsNum < 64.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Replace(System.Text.RegularExpressions.Regex,System.String)">
|
|
<summary>
|
|
Replaces all entries of matchString regular expression with newValue string.
|
|
</summary>
|
|
<param name="pattern">Pattern</param>
|
|
<param name="newValue">Replace text</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Replace(System.String,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Replaces by specified matchString string.
|
|
</summary>
|
|
<param name="matchString">The matchString text.</param>
|
|
<param name="newValue">The newValue text.</param>
|
|
<param name="caseSensitive">if it specifies case sensitive, set to <c>true</c>.</param>
|
|
<param name="wholeWord">if it specifies to search a whole word, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection)">
|
|
<summary>
|
|
Replaces by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Replace(System.Text.RegularExpressions.Regex,Spire.Doc.Documents.TextSelection,System.Boolean)">
|
|
<summary>
|
|
Replaces by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<param name="textSelection">The text selection.</param>
|
|
<param name="saveFormatting">if it specifies save source formatting, set to <c>true</c>.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.Find(System.Text.RegularExpressions.Regex)">
|
|
<summary>
|
|
Finds text by specified pattern.
|
|
</summary>
|
|
<param name="pattern">The pattern.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ApplyVerticalMerge(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Applies the vertical merge for table cells.
|
|
</summary>
|
|
<param name="columnIndex">Index of the column.</param>
|
|
<param name="startRowIndex">Start index of the row.</param>
|
|
<param name="endRowIndex">End index of the row.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ApplyHorizontalMerge(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Applies horizontal merging for cells of table row.
|
|
</summary>
|
|
<param name="rowIndex">Index of the row.</param>
|
|
<param name="startCellIndex">Start index of the cell.</param>
|
|
<param name="endCellIndex">End index of the cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.RemoveAbsPosition">
|
|
<summary>
|
|
Removes the absolute position data. If table has absolute position in the document,
|
|
all position data will be erased.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.SetColumnWidth(System.Int32,System.Single,Spire.Doc.CellWidthType)">
|
|
<summary>
|
|
Sets the width of all cells in the current column of the table.
|
|
</summary>
|
|
<param name="columnIndex">Index of the column.</param>
|
|
<param name="columnWidth">The column width.</param>
|
|
<param name="columnWidthType">The column width type.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.AutoFit(Spire.Doc.AutoFitBehaviorType)">
|
|
<summary>
|
|
Determines how Microsoft Word resizes a table when the AutoFit feature is used.
|
|
</summary>
|
|
<param name="behavior">How Word resizes the specified table with the AutoFit feature is used.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.SetBorders(Spire.Doc.Documents.BorderStyle,System.Single,System.Drawing.Color)">
|
|
<summary>
|
|
Sets the borders for all possible border positions in the table with the specified style, line width, and color.
|
|
</summary>
|
|
<param name="borderStyle">The style of the border (e.g., solid, dashed).</param>
|
|
<param name="lineWidth">The width of the border line.</param>
|
|
<param name="color">The color of the border line.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.SetBorder(Spire.Doc.Formatting.BorderPositions,Spire.Doc.Documents.BorderStyle,System.Single,System.Drawing.Color,System.Boolean)">
|
|
<summary>
|
|
Sets the border for the specified border positions and style.
|
|
</summary>
|
|
<param name="borderPos">The border positions to set.</param>
|
|
<param name="borderStyle">The border style to apply.</param>
|
|
<param name="lineWidth">The line width of the border.</param>
|
|
<param name="color">The color of the border.</param>
|
|
<param name="isOverrideCellBorders">Indicates whether to override cell borders.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Table.ClearBorders">
|
|
<summary>
|
|
Clears the borders of all rows and cells in the table.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.WidthType">
|
|
<summary>
|
|
The TableWidthType enum specifies how the preferred width for a table,
|
|
table indent, table cell, cell margin, or cell spacing is defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WidthType.None">
|
|
<summary>
|
|
No Preffered Width
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WidthType.Auto">
|
|
<summary>
|
|
No preferred width is specified.
|
|
The width is derived from other table measurements where a preferred size is specified,
|
|
as well as from the size of the table contents, and the constraining size of the
|
|
container of the table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WidthType.Percentage">
|
|
<summary>
|
|
When specifying the preferred width of a portion of a table,
|
|
such as a cell, spacing or indent, the percentage is relative
|
|
to the width of the entire table.
|
|
When specifying the preferred width of an entire table,
|
|
the percentage is relative to the width of the page,
|
|
less any margin or gutter space. Alternatively,
|
|
if the table is nested inside another table,
|
|
the percentage is relative to the width of the cell
|
|
in the containing table, less cell margins.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WidthType.Twip">
|
|
<summary>
|
|
The preferred width of the table, indent, cell,
|
|
cell margin, or cell spacing is an absolute width measured in twips.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PreferredWidth">
|
|
<summary>
|
|
An PreferredWidth class that specifies the preferred total width of the table
|
|
of which this row is a part.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PreferredWidth.FromPercent(System.Double)">
|
|
<summary>
|
|
Creates a PreferredWidth instance from a percentage value.
|
|
</summary>
|
|
<param name="percent">The percentage value representing the preferred width, which must be between 0 and MaxPercent.</param>
|
|
<returns>A PreferredWidth instance set to the specified percentage.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.PreferredWidth.FromPoints(System.Double)">
|
|
<summary>
|
|
Creates a PreferredWidth object from a specified number of points.
|
|
</summary>
|
|
<param name="points">The width in points.</param>
|
|
<returns>A PreferredWidth object representing the specified width in points.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.PreferredWidth.#ctor(Spire.Doc.WidthType,System.Int16)">
|
|
<summary>
|
|
Create a new PreferredWidth object
|
|
</summary>
|
|
<param name="type">A enum element from WidthType that specifies the units of measurement for the Value.
|
|
if type is Auto or None, the value must be 0,
|
|
if type is Percentage, the value must be non-negative and less than or equal to 600,
|
|
if type is Twip, the value must be non-negative and and less than or equal to 31,680 (22 inches).
|
|
</param>
|
|
<param name="value">An short value that specifies the preferred width</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.PreferredWidth.Value">
|
|
<summary>
|
|
An double value that specifies the preferred width
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PreferredWidth.Type">
|
|
<summary>
|
|
A enum element from WidthType that specifies the units of measurement for the Value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PreferredWidth.Auto">
|
|
<summary>
|
|
Get an instance of PreferredWidth, this instance indicates
|
|
thie preferred width is auto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PreferredWidth.None">
|
|
<summary>
|
|
Get an instance of PreferredWidth, this instance indicates
|
|
thie preferred width is not specified.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PreferredWidth.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified object is equal to the current object.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns>true if the specified object is equal to the current object; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.PreferredWidth.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for the current instance.
|
|
</summary>
|
|
<returns>A hash code for the current instance.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.TableCell">
|
|
<summary>
|
|
Represents a table cell within a document.
|
|
Implements interfaces for composite objects, document base, cell attribute source, and trackable node.
|
|
Inherits from the Body class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.GridSpan">
|
|
<summary>
|
|
Gets grid Span.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.OwnerRow">
|
|
<summary>
|
|
Gets owner row of the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.CellFormat">
|
|
<summary>
|
|
Gets cell format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.Width">
|
|
<summary>
|
|
Gets the width of the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.CellWidthType">
|
|
<summary>
|
|
Gets the width type of the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableCell.Scaling">
|
|
<summary>
|
|
Gets or sets the cell scaling.
|
|
</summary>
|
|
<value>The scaling.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.TableCell"/> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.GetCellIndex">
|
|
<summary>
|
|
Get cell index in the table row.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.SetCellWidth(System.Single,Spire.Doc.CellWidthType)">
|
|
<summary>
|
|
Set the width and type of the cell.
|
|
</summary>
|
|
<param name="width">Width of the cell.</param>
|
|
<param name="widthType">Width type of the cell.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.GetCellWidth">
|
|
<summary>
|
|
Gets the width of the cell.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.GetCellWidthType">
|
|
<summary>
|
|
Gets the width type of the cell.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableCell.SplitCell(System.Int32,System.Int32)">
|
|
<summary>
|
|
The one cell splits into two or more cells.
|
|
</summary>
|
|
<param name="columnNum">The split column number. Must be greater than or equal to 1 is only valid. </param>
|
|
<param name="rowNum">The split row number. Must be greater than or equal to 1 is only valid. </param>
|
|
</member>
|
|
<member name="T:Spire.Doc.TableRow">
|
|
<summary>
|
|
Represents a table row in a document, inheriting from DocumentBase and implementing various interfaces for row attributes, tracking, and composite objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.ChildObjects">
|
|
<summary>
|
|
Gets the child object.
|
|
</summary>
|
|
<value>The child object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.Cells">
|
|
<summary>
|
|
Returns or sets cell collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.RowFormat">
|
|
<summary>
|
|
Gets the format for the current row.
|
|
</summary>
|
|
<returns>The row format.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.HeightType">
|
|
<summary>
|
|
Gets or sets the height type of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.Height">
|
|
<summary>
|
|
Gets or sets the height of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.TableRow.IsHeader">
|
|
<summary>
|
|
Gets or sets a value indicating whether the table has a header.
|
|
rue if the row is repeated as a table heading on every page when the table spans more than one page.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableRow.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.TableRow"/> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableRow.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableRow.AddCell">
|
|
<summary>
|
|
Adds the cell.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableRow.AddCell(System.Boolean)">
|
|
<summary>
|
|
Adds the cell.
|
|
</summary>
|
|
<param name="isCopyFormat">Specifies whether to apply the parent row format.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.TableRow.GetRowIndex">
|
|
<summary>
|
|
Returns index of the row in owner table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Body">
|
|
<summary>
|
|
Represents a container.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.Paragraphs">
|
|
<summary>
|
|
Gets inner paragraphs
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.Tables">
|
|
<summary>
|
|
Gets inner tables
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.FormFields">
|
|
<summary>
|
|
Gets the form fields.
|
|
</summary>
|
|
<value>The form fields.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.LastParagraph">
|
|
<summary>
|
|
Gets the last paragraph.
|
|
</summary>
|
|
<value>The last paragraph.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.FirstParagraph">
|
|
<summary>
|
|
Gets the First paragraph.
|
|
</summary>
|
|
<value>The last paragraph.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Body.ChildObjects">
|
|
<summary>
|
|
Gets the child entities.
|
|
</summary>
|
|
<value>The child entities.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.AddParagraph">
|
|
<summary>
|
|
Adds paragraph at end of section.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.AddTable">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.AddTable(System.Boolean)">
|
|
<summary>
|
|
Adds the table.
|
|
</summary>
|
|
<param name="showBorder">Is Show Border</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.InsertXHTML(System.String)">
|
|
<summary>
|
|
Inserts html at end of text body.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.InsertXHTML(System.String,System.Int32)">
|
|
<summary>
|
|
Inserts html. Inserting begins from paragraph specified by paragraphIndex
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.InsertXHTML(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Inserts html. Inserting begins from paragraph specified by paragraphIndex,
|
|
and paragraph item specified by paragraphItemIndex
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.IsValidXHTML(System.String,Spire.Doc.Documents.XHTMLValidationType)">
|
|
<summary>
|
|
Validates the XHTML.
|
|
</summary>
|
|
<param name="html">The HTML.</param>
|
|
<param name="type">The validation type.</param>
|
|
<returns>
|
|
if it is valid XHTML, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.IsValidXHTML(System.String,Spire.Doc.Documents.XHTMLValidationType,System.String@)">
|
|
<summary>
|
|
Validates the XHTML.
|
|
</summary>
|
|
<param name="html">The HTML.</param>
|
|
<param name="type">The validation type.</param>
|
|
<param name="exceptionMessage">The exception message.</param>
|
|
<returns>
|
|
if it is valid XHTML, set to <c>true</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Body.EnsureMinimum">
|
|
<summary>
|
|
If the text body has no paragraphs, creates and appends one Paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.BookmarkEnd">
|
|
<summary>
|
|
Represents a bookmark end in a document. This class inherits from ParagraphBase and implements IBookmarkNode and IDocumentWidget interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BookmarkEnd.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.BookmarkEnd.Name">
|
|
<summary>
|
|
Gets the bookmark name.
|
|
</summary>
|
|
<value>The name.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.BookmarkEnd.#ctor(Spire.Doc.Interface.IDocument,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.BookmarkEnd"/> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.BookmarkStart">
|
|
<summary>
|
|
Represents a bookmark start in a document. Inherits from ParagraphBase and implements IBookmarkNode and IDocumentWidget interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.BookmarkStart.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.BookmarkStart.Name">
|
|
<summary>
|
|
Gets the bookmark name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.BookmarkStart.#ctor(Spire.Doc.Interface.IDocument,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.BookmarkStart"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Break">
|
|
<summary>
|
|
Represents a break in the document, typically used to insert a line break or page break.
|
|
Inherits from ParagraphBase and implements IDocumentWidget interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Break.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Break.BreakType">
|
|
<summary>
|
|
Gets the type of the break.
|
|
</summary>
|
|
<value>The type of the break.</value>
|
|
</member>
|
|
<member name="M:Spire.Doc.Break.#ctor(Spire.Doc.Interface.IDocument)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Break"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Break.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.Documents.BreakType)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Break"/> class.
|
|
</summary>
|
|
<param name="doc">Document</param>
|
|
<param name="breakType">Break type</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Break.CloneImpl">
|
|
<summary>
|
|
Clones the current object using the default cloning behavior.
|
|
</summary>
|
|
<returns>A new object that is a copy of the current object.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.PermissionEnd">
|
|
<summary>
|
|
Represents end of an editable range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionEnd.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionEnd.Id">
|
|
<summary>
|
|
Gets the permission id.
|
|
</summary>
|
|
<value>The name.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionEnd.EditorGroup">
|
|
<summary>
|
|
Gets permission editorgroup.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PermissionEnd.#ctor(Spire.Doc.Interface.IDocument,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:PermEnd"/> class.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.PermissionStart">
|
|
<summary>
|
|
Represents start of an editable range.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionStart.DocumentObjectType">
|
|
<summary>
|
|
Gets the type of the document object.
|
|
</summary>
|
|
<value>The type of the document object.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionStart.Id">
|
|
<summary>
|
|
Gets the permissionstart id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.PermissionStart.EditorGroup">
|
|
<summary>
|
|
Gets permission editorgroup.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.PermissionStart.#ctor(Spire.Doc.Interface.IDocument,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="!:PermStart"/> class.
|
|
</summary>
|
|
<param name="doc">The doc.</param>
|
|
<param name="name">The name.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.IRowsEnumerator">
|
|
<summary>
|
|
Represents an enumerator for iterating through rows of data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.IRowsEnumerator.Reset">
|
|
<summary>
|
|
Resets the object's state to its initial values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.IRowsEnumerator.NextRow">
|
|
<summary>
|
|
Advances to the next row in the result set.
|
|
</summary>
|
|
<returns>True if there are more rows, false otherwise.</returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.IRowsEnumerator.GetCellValue(System.String)">
|
|
<summary>
|
|
Retrieves the value of a cell based on the specified column name.
|
|
</summary>
|
|
<param name="columnName">The name of the column to retrieve the value from.</param>
|
|
<returns>The value of the cell.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.ColumnNames">
|
|
<summary>
|
|
Gets an array of column names in the table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.RowsCount">
|
|
<summary>
|
|
Gets the count of rows in the data structure.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.CurrentRowIndex">
|
|
<summary>
|
|
Gets the index of the current row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.TableName">
|
|
<summary>
|
|
Gets the name of the table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.IsEnd">
|
|
<summary>
|
|
Gets a value indicating whether the current position is at the end of the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.IRowsEnumerator.IsLast">
|
|
<summary>
|
|
Gets a value indicating whether the current item is the last item in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.GroupEventType">
|
|
<summary>
|
|
Represents different types of events that can occur in a group.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Reporting.GroupEventType.GroupStart">
|
|
<summary>
|
|
The group start
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Reporting.GroupEventType.GroupEnd">
|
|
<summary>
|
|
The group end
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Reporting.GroupEventType.TableStart">
|
|
<summary>
|
|
The table start
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Reporting.GroupEventType.TableEnd">
|
|
<summary>
|
|
The table end
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeGroupEventArgs">
|
|
<summary>
|
|
Represents the event arguments for the MergeGroup event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.Document">
|
|
<summary>
|
|
Gets the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.TableName">
|
|
<summary>
|
|
Gets the Table Name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.GroupName">
|
|
<summary>
|
|
Gets the group name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.MergeField">
|
|
<summary>
|
|
Gets the merge field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.RowIndex">
|
|
<summary>
|
|
Gets the index of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.RowCount">
|
|
<summary>
|
|
Gets the count of the row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeGroupEventArgs.EventType">
|
|
<summary>
|
|
Gets or sets the type of the group event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeGroupEventArgs.#ctor(Spire.Doc.Interface.IDocument,Spire.Doc.Reporting.IRowsEnumerator,Spire.Doc.Reporting.GroupEventType)">
|
|
<summary>
|
|
Represents data during the MergeGroup event.
|
|
</summary>
|
|
<param name="doc">Document Ojbect</param>
|
|
<param name="tableName">Table Name</param>
|
|
<param name="rowIndex">Row Index</param>
|
|
<param name="eventType">Event Type</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeGroupEventHandler">
|
|
<summary>
|
|
Represents the Method that handles Merage group event.
|
|
</summary>
|
|
<param name="doc">Document object</param>
|
|
<param name="Name">Group or table name</param>
|
|
<param name="rowIndex">Represents the Row Index.</param>
|
|
<param name="IsTable">Indicates is table, otherwise is group</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MailMerge">
|
|
<summary>
|
|
Represents a class for performing mail merge operations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.ClearFields">
|
|
<summary>
|
|
Gets or sets a value indicating whether [clear fields]. by default value is true.
|
|
</summary>
|
|
<value><c>true</c> if it clears the fields, set to <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.MailMergeMainDocumentType">
|
|
<summary>
|
|
Specifies the possible types for a mail merge source document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.ClearGroupTag">
|
|
<summary>
|
|
Gets or sets a value indicating whether [clear group tag]. by default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.HideEmptyParagraphs">
|
|
<summary>
|
|
Gets or sets a value indicating whether to remove paragraphs which contain empty merge fields
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.HideEmptyGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether to remove groups which contain empty merge fields
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMerge.MappedFields">
|
|
<summary>
|
|
Gets the collection of mapped fields. Mapped fields represent mapping between
|
|
fields names in the data source and mail merge fields in the document. The keys of
|
|
the collection are merge field names and the values are field names in the data source.
|
|
</summary>
|
|
<value>The collection of mapped fields.</value>
|
|
</member>
|
|
<member name="E:Spire.Doc.Reporting.MailMerge.MergeField">
|
|
<summary>
|
|
Occurs during mail merge when a text merge field processing.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Reporting.MailMerge.MergeImageField">
|
|
<summary>
|
|
Occurs during mail merge when an image merge field processing.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Spire.Doc.Reporting.MailMerge.MergeGroup">
|
|
<summary>
|
|
Occurs during mail merge when group/table processing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.String[],System.String[])">
|
|
<summary>
|
|
Performs mail merge operation.
|
|
</summary>
|
|
<param name="fieldNames"></param>
|
|
<param name="fieldValues"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.Data.DataRow)">
|
|
<summary>
|
|
Performs mail merge from a DataRow into the document
|
|
</summary>
|
|
<param name="row"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Performs mail merge operation.
|
|
</summary>
|
|
<param name="dataSource">IEnumerable data source</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.Data.DataTable)">
|
|
<summary>
|
|
Performs mail merge from a DataTable
|
|
</summary>
|
|
<param name="table"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.Data.DataView)">
|
|
<summary>
|
|
Performs mail merge from a DataView
|
|
</summary>
|
|
<param name="dataView"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.Execute(System.Data.IDataReader)">
|
|
<summary>
|
|
Performs mail merge from a DataView
|
|
</summary>
|
|
<param name="dataReader"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthRegion(System.Data.DataTable)">
|
|
<summary>
|
|
Performs Mail Merge within a region from a DataTable.
|
|
</summary>
|
|
<param name="table"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthRegion(System.Data.DataView)">
|
|
<summary>
|
|
Performs Mail Merge within a region from a DataView.
|
|
</summary>
|
|
<param name="dataView"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthRegion(System.Data.IDataReader)">
|
|
<summary>
|
|
Performs Mail Merge within a region from a DataReader.
|
|
</summary>
|
|
<param name="dataReader"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthNestedRegion(Spire.Doc.Reporting.MailMergeDataSet,System.Collections.Generic.List{System.Collections.DictionaryEntry})">
|
|
<summary>
|
|
Performs mail merge operation.
|
|
</summary>
|
|
<param name="dataSource">MailMergeDataSet</param>
|
|
<param name="commands">Commands list</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthNestedRegion(System.Data.Common.DbConnection,System.Collections.Generic.List{System.Collections.DictionaryEntry})">
|
|
<summary>
|
|
Executes nested mailmerge within a region for the specified data.
|
|
</summary>
|
|
<param name="conn">The Connection.</param>
|
|
<param name="commands">The commands.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteWidthNestedRegion(System.Data.DataSet,System.Collections.Generic.List{System.Collections.DictionaryEntry})">
|
|
<summary>
|
|
Executes the nested region.
|
|
</summary>
|
|
<param name="dataSet">The data set.</param>
|
|
<param name="commands">The commands.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.GetMergeFieldNames">
|
|
<summary>
|
|
Returns a collection of mergefield names found in the document.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.GetMergeFieldNames(System.String)">
|
|
<summary>
|
|
Gets the merge field names.
|
|
</summary>
|
|
<param name="groupName">Name of the region.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.GetMergeGroupNames">
|
|
<summary>
|
|
Gets the merge field names.
|
|
</summary>
|
|
<param name="groupName">Name of the region.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMerge.ExecuteGroup(Spire.Doc.Reporting.MailMergeDataTable)">
|
|
<summary>
|
|
Performs mail merge operation.
|
|
</summary>
|
|
<param name="datatable">MailMergeDataTable</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeFieldEventHandler">
|
|
<summary>
|
|
Represents the mail merge functionality.
|
|
</summary>
|
|
<summary>
|
|
Represents the MergeField event
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeImageFieldEventHandler">
|
|
<summary>
|
|
Represents the Method that handles MergeImageField event
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeFieldEventArgs">
|
|
<summary>
|
|
Represents data during MergeField event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.Document">
|
|
<summary>
|
|
Gets the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.FieldName">
|
|
<summary>
|
|
Gets the Merge field Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.FieldValue">
|
|
<summary>
|
|
Gets the Merge Field Value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.TableName">
|
|
<summary>
|
|
Gets the Table Name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.RowIndex">
|
|
<summary>
|
|
Gets the Row Index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.CharacterFormat">
|
|
<summary>
|
|
Gets the Character Format of the field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.Text">
|
|
<summary>
|
|
Gets the Text value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.CurrentMergeField">
|
|
<summary>
|
|
Gets the current Merge field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.IsKeepTextFormat">
|
|
<summary>
|
|
Gets or sets if keep text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeFieldEventArgs.IsKeepHtmlTextFormat">
|
|
<summary>
|
|
Gets or sets if keep html text formatting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeFieldEventArgs.#ctor(Spire.Doc.Interface.IDocument,System.String,System.Int32,Spire.Doc.Interface.IMergeField,System.Object)">
|
|
<summary>
|
|
Provides data during the MergeField event.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
<param name="tableName"></param>
|
|
<param name="rowIndex"></param>
|
|
<param name="field"></param>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MergeImageFieldEventArgs">
|
|
<summary>
|
|
Represents data during MergeImageField event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.UseText">
|
|
<summary>
|
|
Setting to specify if Text should be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.ImageFileName">
|
|
<summary>
|
|
Returns or sets Image File Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.ImageStream">
|
|
<summary>
|
|
Returns or sets Image Stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.Image">
|
|
<summary>
|
|
Returns or sets the Image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.PictureSize">
|
|
<summary>
|
|
Gets or sets the size of the picture.
|
|
</summary>
|
|
<value>The size of the picture.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.Skip">
|
|
<summary>
|
|
Gets or sets a value indicating whether this <see cref="T:Spire.Doc.Reporting.MergeImageFieldEventArgs"/> is skip.
|
|
</summary>
|
|
<value><c>true</c> if skip; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MergeImageFieldEventArgs.ImageLink">
|
|
<summary>
|
|
Gets or sets hyperlink of the picture.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeImageFieldEventArgs.#ctor(Spire.Doc.Interface.IDocument,System.String,System.Int32,Spire.Doc.Interface.IMergeField,System.Drawing.Image)">
|
|
<summary>
|
|
Provides data during MergeImageField event.
|
|
</summary>
|
|
<param name="doc"></param>
|
|
<param name="tableName"></param>
|
|
<param name="rowIndex"></param>
|
|
<param name="field"></param>
|
|
<param name="image"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeImageFieldEventArgs.#ctor(Spire.Doc.Interface.IDocument,System.String,System.Int32,Spire.Doc.Interface.IMergeField,System.Object)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Reporting.MergeImageFieldEventArgs"/> class.
|
|
</summary>
|
|
<param name="doc">The document.</param>
|
|
<param name="tableName">Name of the table.</param>
|
|
<param name="rowIndex">Index of the row.</param>
|
|
<param name="field">The field.</param>
|
|
<param name="obj">The object.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeImageFieldEventArgs.SetImage(System.String)">
|
|
<summary>
|
|
Sets the image.
|
|
</summary>
|
|
<param name="imgFile">The image file.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MergeImageFieldEventArgs.SetImage(System.IO.Stream)">
|
|
<summary>
|
|
Sets the image.
|
|
</summary>
|
|
<param name="imgStream">The image stream.</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.ObjectEntry">
|
|
<summary>
|
|
the document objectEntry class maintains the Entries of DocumentObject class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.ObjectEntry.Current">
|
|
<summary>
|
|
Current entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.ObjectEntry.Index">
|
|
<summary>
|
|
Index value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.ObjectEntry.#ctor(Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
The base class for DLS entities.
|
|
</summary>
|
|
<param name="ent"></param>
|
|
<param name="index"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.ObjectEntry.Fetch">
|
|
<summary>
|
|
Fetches the entries element.
|
|
</summary>
|
|
<returns>if contains entry, it will return true. Otherwise, it returns false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.EntityEntry">
|
|
<summary>
|
|
the document objectEntry class maintains the Entries of Entity class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.EntityEntry.Current">
|
|
<summary>
|
|
Current entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.EntityEntry.Index">
|
|
<summary>
|
|
Index value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.EntityEntry.#ctor(Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
The base class for DLS entities.
|
|
</summary>
|
|
<param name="ent"></param>
|
|
<param name="index"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.EntityEntry.Fetch">
|
|
<summary>
|
|
Fetches the entries element.
|
|
</summary>
|
|
<returns>if contains entry, it will return true. Otherwise, it returns false.</returns>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MailMergeDataSet">
|
|
<summary>
|
|
Represents a data set for mail merge operations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMergeDataSet.DataSet">
|
|
<summary>
|
|
Gets list of MailMergeDataTables
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMergeDataSet.#ctor">
|
|
<summary>
|
|
Create new instance of MailMergeDataSet
|
|
</summary>
|
|
<param name="dataSet">list of MailMergeDataTables</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMergeDataSet.Add(System.Object)">
|
|
<summary>
|
|
Append new MailMergeDataTable to MailMergeDataSet
|
|
</summary>
|
|
<param name="dataTable">MailMergeDataTable</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMergeDataSet.Clear">
|
|
<summary>
|
|
Cleans MailMergeDataSet of any data by removing all MaillMergeDataTable
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Reporting.MailMergeDataTable">
|
|
<summary>
|
|
Represents a table of data for mail merge operations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMergeDataTable.GroupName">
|
|
<summary>
|
|
Get group name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Reporting.MailMergeDataTable.SourceData">
|
|
<summary>
|
|
Get sourse data
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Reporting.MailMergeDataTable.#ctor(System.String,System.Collections.IEnumerable)">
|
|
<summary>
|
|
Create new instance of object
|
|
</summary>
|
|
<param name="groupName">Group Name</param>
|
|
<param name="sourceData">Sourse data Dictionary</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.FileCorruptException">
|
|
<summary>
|
|
Summary description for StreamReadError.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.FileCorruptException.#ctor">
|
|
<summary>
|
|
Default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.FileCorruptException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.FileCorruptException"/> class.
|
|
</summary>
|
|
<param name="innerExc">The inner exc.</param>
|
|
</member>
|
|
<member name="M:Spire.Doc.FileCorruptException.#ctor(System.String)">
|
|
<summary>
|
|
Throws Exception when document appears to be corrupted and impossible.
|
|
</summary>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.FileCorruptException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Throws Exception when document appears to be corrupted and impossible.
|
|
</summary>
|
|
<param name="message"></param>
|
|
<param name="innerExc"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.FileCorruptException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Throws Exception when document appears to be corrupted and impossible.
|
|
</summary>
|
|
<param name="info"></param>
|
|
<param name="context"></param>
|
|
</member>
|
|
<member name="M:Spire.Doc.Layout.Validation.DocumentValidator.AddBlankTextToEmptyParagraphs(Spire.Doc.Documents.Paragraph)">
|
|
<summary>
|
|
Adds the specified blank text to the empty paragraphs in the footnote tail object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Layout.CommentDisplayMode">
|
|
<summary>
|
|
Specifies the rendering mode for document comments.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Layout.CommentDisplayMode.Hide">
|
|
<summary>
|
|
No document comments are rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Layout.CommentDisplayMode.ShowInBalloons">
|
|
<summary>
|
|
Renders document comments in balloons in the margin. This is the default value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Layout.CommentDisplayMode.ShowInAnnotations">
|
|
<summary>
|
|
Renders document comments in annotations. This is only available for Pdf format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Layout.Fields.FieldOptions">
|
|
<summary>
|
|
Represents a class for field options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Layout.Fields.FieldOptions.CultureSource">
|
|
<summary>
|
|
Gets or sets a value that specifies the culture source to be used while update. The default value is FieldCode.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Layout.Fields.FieldCultureSource">
|
|
<summary>
|
|
Indicates what culture to use during field update.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Layout.Fields.FieldCultureSource.CurrentThread">
|
|
<summary>
|
|
The culture of the current thread is used to update field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Layout.Fields.FieldCultureSource.FieldCode">
|
|
<summary>
|
|
The culture specified in the field formatting with language setting is used.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Layout.DocumentLayoutOptions">
|
|
<summary>
|
|
Represents the settings for managing the document layout procedure.
|
|
The related layout settings are only supported for new engines.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Layout.DocumentLayoutOptions.ShowHiddenText">
|
|
<summary>
|
|
Gets or sets a value indicating whether is show hidden text.
|
|
Default is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Layout.DocumentLayoutOptions.UseHarfBuzzTextShaper">
|
|
<summary>
|
|
Gets or sets a value indicating whether use HarfBuzz text shaper.
|
|
The default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Layout.DocumentLayoutOptions.CommentDisplayMode">
|
|
<summary>
|
|
Gets or sets the way comments are rendered.
|
|
Default value is <see cref="F:Spire.Doc.Layout.CommentDisplayMode.ShowInBalloons" />.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.LayoutElementType">
|
|
<summary>
|
|
Types of the layout entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.None">
|
|
<summary>
|
|
Default value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Page">
|
|
<summary>
|
|
Represents page of a document.
|
|
Page may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Column" />, <see cref="F:Spire.Doc.Pages.LayoutElementType.HeaderFooter" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Comment" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Column">
|
|
<summary>
|
|
Represents a column of text on a page.
|
|
Column may have the same child entities as <see cref="F:Spire.Doc.Pages.LayoutElementType.Cell" />, plus <see cref="F:Spire.Doc.Pages.LayoutElementType.Footnote" />,
|
|
<see cref="F:Spire.Doc.Pages.LayoutElementType.Endnote" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.NoteSeparator" /> entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Row">
|
|
<summary>
|
|
Represents a table row.
|
|
Row may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Cell" /> as child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Cell">
|
|
<summary>
|
|
Represents a table cell.
|
|
Cell may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Line">
|
|
<summary>
|
|
Represents line of characters of text and inline objects.
|
|
Line may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Span" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Span">
|
|
<summary>
|
|
Represents one or more characters in a line.
|
|
This include special characters like field start/end markers, bookmarks and comments.
|
|
Span may not have child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Footnote">
|
|
<summary>
|
|
Represents placeholder for footnote content.
|
|
Footnote may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Endnote">
|
|
<summary>
|
|
Represents placeholder for endnote content.
|
|
Endnote may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.HeaderFooter">
|
|
<summary>
|
|
Represents placeholder for header/footer content on a page.
|
|
HeaderFooter may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.TextBox">
|
|
<summary>
|
|
Represents text area inside of a shape.
|
|
Textbox may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.Comment">
|
|
<summary>
|
|
Represents placeholder for comment content.
|
|
Comment may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Pages.LayoutElementType.NoteSeparator">
|
|
<summary>
|
|
Represents footnote/endnote separator.
|
|
NoteSeparator may have <see cref="F:Spire.Doc.Pages.LayoutElementType.Line" /> and <see cref="F:Spire.Doc.Pages.LayoutElementType.Row" /> child entities.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.LayoutCollection`1">
|
|
<summary>
|
|
Represents a generic collection of layout entity types.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutCollection`1.First">
|
|
<summary>
|
|
Returns the first entity in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutCollection`1.Last">
|
|
<summary>
|
|
Returns the last entity in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutCollection`1.Item(System.Int32)">
|
|
<summary>
|
|
Retrieves the entity at the given index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Pages.LayoutCollection`1.IndexOf(`0)">
|
|
<summary>
|
|
Returns the zero-based index of the first occurrence of a specific item in the collection.
|
|
</summary>
|
|
<param name="item">The item to locate in the collection.</param>
|
|
<returns>The zero-based index of the first occurrence of item if found; otherwise, -1.</returns>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutCollection`1.Count">
|
|
<summary>
|
|
Gets the number of entities in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.LayoutElement">
|
|
<summary>
|
|
The class serves as the foundation for elements in a document that have been rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.PageIndex">
|
|
<summary>
|
|
Gets the index of a page in which rendered object. starting from 1.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.Rectangle">
|
|
<summary>
|
|
Returns bounding rectangle of the entity relative to the page top left corner (in points).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.Type">
|
|
<summary>
|
|
Gets the type of this layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.Text">
|
|
<summary>
|
|
Outputs the entity's contents as a plain text string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.Parent">
|
|
<summary>
|
|
Gets the parent of this entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.LayoutElement.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Pages.LayoutElement.GetChildEntities(Spire.Doc.Pages.LayoutElementType,System.Boolean)">
|
|
<summary>
|
|
Obtains a group of child entities that are of a specific type.
|
|
</summary>
|
|
<param name="type">Specifies the type of entities to select.</param>
|
|
<param name="isDeep">True to select from all child entities recursively.
|
|
False to select only among immediate children</param>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutCell">
|
|
<summary>
|
|
Describes the cell within a table.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutCell.Cell">
|
|
<summary>
|
|
Returns the cell that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutCell.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutColumn">
|
|
<summary>
|
|
Represents a column of text on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutColumn.Footnotes">
|
|
<summary>
|
|
Provides access to the footnotes of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutColumn.Endnotes">
|
|
<summary>
|
|
Provides access to the endnotes of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutColumn.NoteSeparators">
|
|
<summary>
|
|
Provides access to the note separators of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutColumn.Body">
|
|
<summary>
|
|
Returns the body that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutColumn.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutComment">
|
|
<summary>
|
|
Represents placeholder for comment content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutComment.Comment">
|
|
<summary>
|
|
Returns the comment that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutComment.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutDocument">
|
|
<summary>
|
|
Provides an API wrapper for the LayoutEnumerator class to access the page layout
|
|
of a document presented in an object model like the design.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Pages.FixedLayoutDocument.#ctor(Spire.Doc.Document)">
|
|
<summary>
|
|
Creates a new instance from the supplied Document class.
|
|
</summary>
|
|
<param name="doc">A document whose page layout model to enumerate.</param>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutDocument.Pages">
|
|
<summary>
|
|
Provides access to the pages of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutDocument.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Pages.FixedLayoutDocument.GetLayoutEntitiesOfNode(Spire.Doc.DocumentObject)">
|
|
<summary>
|
|
Returns all the layout entities of the specified node.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutEndnote">
|
|
<summary>
|
|
Represents placeholder for endnote content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutEndnote.Endnote">
|
|
<summary>
|
|
Returns the endnote that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutEndnote.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutFootnote">
|
|
<summary>
|
|
Represents placeholder for footnote content.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutFootnote.Footnote">
|
|
<summary>
|
|
Returns the footnote that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutFootnote.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutHeaderFooter">
|
|
<summary>
|
|
Represents the header/footer content on a page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutHeaderFooter.Kind">
|
|
<summary>
|
|
Returns the type of the header or footer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutLine">
|
|
<summary>
|
|
Represents line of characters of text and inline objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutLine.Text">
|
|
<summary>
|
|
Exports the contents of the entity into a string in plain text format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutLine.Paragraph">
|
|
<summary>
|
|
Returns the paragraph that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutLine.Spans">
|
|
<summary>
|
|
Provides access to the spans of the line.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutNoteSeparator">
|
|
<summary>
|
|
Represents footnote/endnote separator.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutNoteSeparator.Footnote">
|
|
<summary>
|
|
Returns the footnote/endnote that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutNoteSeparator.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutPage">
|
|
<summary>
|
|
Represents page of a document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutPage.Columns">
|
|
<summary>
|
|
Provides access to the columns of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutPage.HeaderFooters">
|
|
<summary>
|
|
Provides access to the header and footers of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutPage.Comments">
|
|
<summary>
|
|
Provides access to the comments of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutPage.Section">
|
|
<summary>
|
|
Returns the section that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutPage.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutRow">
|
|
<summary>
|
|
Represents a table row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutRow.Cells">
|
|
<summary>
|
|
Provides access to the cells of the table row.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutRow.Row">
|
|
<summary>
|
|
Returns the row that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutRow.Table">
|
|
<summary>
|
|
Returns the table that corresponds to the layout entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutRow.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutSpan">
|
|
<summary>
|
|
Represents one or more characters in a line.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Spire.Doc.Pages.FixedLayoutSpan.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Spire.Doc.Pages.FixedLayoutSpan"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutSpan.Kind">
|
|
<summary>
|
|
Gets kind of the span. This cannot be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutSpan.Text">
|
|
<summary>
|
|
Exports the contents of the entity into a string in plain text format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutSpan.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.FixedLayoutTextBox">
|
|
<summary>
|
|
Represents text area inside of a shape.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.FixedLayoutTextBox.ParentNode">
|
|
<summary>
|
|
Provides the layout node that pertains to this particular entity.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Pages.BodyLayoutElement">
|
|
<summary>
|
|
Describes an object that includes both lines and rows.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.BodyLayoutElement.Lines">
|
|
<summary>
|
|
Gives the ability to retrieve the individual lines comprising a body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.Doc.Pages.BodyLayoutElement.Rows">
|
|
<summary>
|
|
Gives the capability to access the rows contained within a table.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Printing.PagesPerSheet">
|
|
<summary>
|
|
Represents the number of pages that can be printed on a single sheet of paper.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.OnePage">
|
|
<summary>
|
|
Print one page per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.TwoPages">
|
|
<summary>
|
|
Print two pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.FourPages">
|
|
<summary>
|
|
Print four pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.SixPages">
|
|
<summary>
|
|
Print six pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.EightPages">
|
|
<summary>
|
|
Print eight pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.NinePages">
|
|
<summary>
|
|
Print nine pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Printing.PagesPerSheet.SixteenPages">
|
|
<summary>
|
|
Print sixteen pages per sheet.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.Publics.Drawing.FontStyle">
|
|
<summary>
|
|
Specifies style information applied to text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Publics.Drawing.FontStyle.Regular">
|
|
<summary>
|
|
Normal text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Publics.Drawing.FontStyle.Bold">
|
|
<summary>
|
|
Bold text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Publics.Drawing.FontStyle.Italic">
|
|
<summary>
|
|
Italic text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Publics.Drawing.FontStyle.Underline">
|
|
<summary>
|
|
Underlined text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.Publics.Drawing.FontStyle.Strikeout">
|
|
<summary>
|
|
Text with a line through the middle.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FileFormat">
|
|
<summary>
|
|
Type of file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Doc">
|
|
<summary>
|
|
Microsoft Word 97 - 2003 Binary Document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dot">
|
|
<summary>
|
|
Microsoft Word 97 - 2003 Binary Document or Template.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docx">
|
|
<summary>
|
|
Microsoft Word 2007 Document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docx2010">
|
|
<summary>
|
|
Microsoft Word 2010 Document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docx2013">
|
|
<summary>
|
|
Microsoft Word 2013 Document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docx2016">
|
|
<summary>
|
|
Microsoft Word 2016 Document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docx2019">
|
|
<summary>
|
|
Microsoft Word 2019 Document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotx">
|
|
<summary>
|
|
Microsoft Word 2007 Template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotx2010">
|
|
<summary>
|
|
Microsoft Word 2010 Template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotx2013">
|
|
<summary>
|
|
Microsoft Word 2013 Template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotx2016">
|
|
<summary>
|
|
Microsoft Word 2016 Template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotx2019">
|
|
<summary>
|
|
Microsoft Word 2019 Template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docm">
|
|
<summary>
|
|
Microsoft Word 2007 macro enabled file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docm2010">
|
|
<summary>
|
|
Microsoft Word 2010 macro enabled file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docm2013">
|
|
<summary>
|
|
Microsoft Word 2013 macro enabled file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docm2016">
|
|
<summary>
|
|
Microsoft Word 2016 macro enabled file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Docm2019">
|
|
<summary>
|
|
Microsoft Word 2019 macro enabled file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotm">
|
|
<summary>
|
|
Microsoft Word 2007 macro enabled template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotm2010">
|
|
<summary>
|
|
Microsoft Word 2010 macro enabled template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotm2013">
|
|
<summary>
|
|
Microsoft Word 2013 macro enabled template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotm2016">
|
|
<summary>
|
|
Microsoft Word 2016 macro enabled template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Dotm2019">
|
|
<summary>
|
|
Microsoft Word 2019 macro enabled template format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.OOXML">
|
|
<summary>
|
|
Office Open Xml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.WordML">
|
|
<summary>
|
|
Word xml format for for word 2003
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.WordXml">
|
|
<summary>
|
|
Word xml format for word 2007-2013
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Odt">
|
|
<summary>
|
|
OpenDocument format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Ott">
|
|
<summary>
|
|
OpenDocument Template format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.PDF">
|
|
<summary>
|
|
PDF format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Txt">
|
|
<summary>
|
|
Text file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Rtf">
|
|
<summary>
|
|
Rtf format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.SVG">
|
|
<summary>
|
|
Scalable vector graphics format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Xml">
|
|
<summary>
|
|
Xml file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Mhtml">
|
|
<summary>
|
|
Mhtml format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Html">
|
|
<summary>
|
|
Html format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.HtmlFixed">
|
|
<summary>
|
|
Html format using absolutely positioned elements
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.XPS">
|
|
<summary>
|
|
XPS format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.EPub">
|
|
<summary>
|
|
EPub format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.DocPre97">
|
|
<summary>
|
|
The document is in the Word 6 or Word 95 format. Spire.Doc does not currently support loading such documents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.PostScript">
|
|
<summary>
|
|
PostScript (PS) format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.PCL">
|
|
<summary>
|
|
Printer Command Language (PCL) format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.OFD">
|
|
<summary>
|
|
Open Fixed-layout Document (OFD) format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.OnlineDoc">
|
|
<summary>
|
|
Only for Spire Online editing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Wps">
|
|
<summary>
|
|
Word processing system format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Wpt">
|
|
<summary>
|
|
Word processing technician format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Markdown">
|
|
<summary>
|
|
Markdown format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FileFormat.Auto">
|
|
<summary>
|
|
Instructs Spire.Doc to recognize the format automatically.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.AutoFitBehaviorType">
|
|
<summary>
|
|
Specifies how Microsoft Word resizes a table when the AutoFit feature is used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AutoFitBehaviorType.AutoFitToContents">
|
|
<summary>
|
|
The table is automatically sized to fit the content contained in the table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AutoFitBehaviorType.AutoFitToWindow">
|
|
<summary>
|
|
The table is automatically sized to the width of the active window.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.AutoFitBehaviorType.FixedColumnWidths">
|
|
<summary>
|
|
The table is set to a fixed size, regardless of the content, and is not automatically sized.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.HttpContentType">
|
|
<summary>
|
|
Http content to browser.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HttpContentType.InBrowser">
|
|
<summary>
|
|
LoadFromStream directly in browser.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HttpContentType.Attachment">
|
|
<summary>
|
|
SaveToFile as attachment to the disk.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ProtectionType">
|
|
<summary>
|
|
Type of the protection in the document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ProtectionType.AllowOnlyComments">
|
|
<summary>
|
|
Only modify comments in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ProtectionType.AllowOnlyFormFields">
|
|
<summary>
|
|
Only enter data in the form fields in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ProtectionType.AllowOnlyReading">
|
|
<summary>
|
|
Only reading are allowed in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ProtectionType.AllowOnlyRevisions">
|
|
<summary>
|
|
Only add revision marks to the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ProtectionType.NoProtection">
|
|
<summary>
|
|
Not protected
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.TextureStyle">
|
|
<summary>
|
|
Style of the Texture
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FieldType">
|
|
<summary>
|
|
Type of fields
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNone">
|
|
<summary>
|
|
Field type is not specified or unknown.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAddin">
|
|
<summary>
|
|
Specifies that the field contains data created by an add-in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAdvance">
|
|
<summary>
|
|
Offset subsequent text within a line to the left, right, up or down.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAsk">
|
|
<summary>
|
|
Prompt the user for text to assign to a bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAuthor">
|
|
<summary>
|
|
The name of the document's author from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAutoNum">
|
|
<summary>
|
|
Insert an automatic number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAutoNumLegal">
|
|
<summary>
|
|
Insert an automatic number in legal format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAutoNumOutline">
|
|
<summary>
|
|
Insert an automatic number in outline format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAutoText">
|
|
<summary>
|
|
Insert an AutoText entry.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAutoTextList">
|
|
<summary>
|
|
Insert text based on style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldBarcode">
|
|
<summary>
|
|
Insert a delivery point barcode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldCitation">
|
|
<summary>
|
|
According to the citation style you choose, show an information about a particular source.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldComments">
|
|
<summary>
|
|
The comments from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldCompare">
|
|
<summary>
|
|
Compares two values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldCreateDate">
|
|
<summary>
|
|
The date the document was created.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldData">
|
|
<summary>
|
|
Specifies data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDatabase">
|
|
<summary>
|
|
Insert data from an external database.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDate">
|
|
<summary>
|
|
Specified Today`s Date.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDDE">
|
|
<summary>
|
|
Specified Type as DDE.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDDEAuto">
|
|
<summary>
|
|
Specified Type as DDEAuto.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDocProperty">
|
|
<summary>
|
|
Insert the value of the property
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDocVariable">
|
|
<summary>
|
|
Insert the value of the document variable.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldEditTime">
|
|
<summary>
|
|
The total document editing time.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldEmbed">
|
|
<summary>
|
|
Specifies OLE embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldEmpty">
|
|
<summary>
|
|
Specified Empty Field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFormula">
|
|
<summary>
|
|
Specifies Field Expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFileName">
|
|
<summary>
|
|
The document's name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFileSize">
|
|
<summary>
|
|
The size on disk of the active document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFillIn">
|
|
<summary>
|
|
Prompt the user for text to insert in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFootnoteRef">
|
|
<summary>
|
|
Specifies Type as FootnoteRef.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFormCheckBox">
|
|
<summary>
|
|
Specifies Check box control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFormDropDown">
|
|
<summary>
|
|
Specifies Drop Down box control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldFormTextInput">
|
|
<summary>
|
|
Specifies Text control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldEquation">
|
|
<summary>
|
|
The EQ field is used to display a mathematical equation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldGlossary">
|
|
<summary>
|
|
Specifies FieldGlossary.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldGoToButton">
|
|
<summary>
|
|
Specifies GoToButton control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldHTMLActiveX">
|
|
<summary>
|
|
Specifies HTMLActiveX control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldHyperlink">
|
|
<summary>
|
|
Specifies Hyperlink control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldIf">
|
|
<summary>
|
|
Evaluate arguments conditionally.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldImport">
|
|
<summary>
|
|
Specifies Type as Import.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldInclude">
|
|
<summary>
|
|
Specifies Type as Export.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldIncludePicture">
|
|
<summary>
|
|
Insert a picture from a file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldIncludeText">
|
|
<summary>
|
|
Insert text from a file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldIndex">
|
|
<summary>
|
|
Create an index.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldIndexEntry">
|
|
<summary>
|
|
Mark an index entry.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldInfo">
|
|
<summary>
|
|
Data from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldKeyWord">
|
|
<summary>
|
|
The keywords from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldLastSavedBy">
|
|
<summary>
|
|
Name of user who last saved the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldLink">
|
|
<summary>
|
|
Linked OLE2 object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldListNum">
|
|
<summary>
|
|
Insert an element in a list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMacroButton">
|
|
<summary>
|
|
Run a macro.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMergeField">
|
|
<summary>
|
|
Insert a mail merge field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMergeRec">
|
|
<summary>
|
|
The number of the current merge record.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMergeSeq">
|
|
<summary>
|
|
Merge record sequence number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNext">
|
|
<summary>
|
|
Go to the next record in a mail merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNextIf">
|
|
<summary>
|
|
Conditionally go to the next record in a mail merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNoteRef">
|
|
<summary>
|
|
Insert the number of a footnote or endnote.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNumChars">
|
|
<summary>
|
|
The number of characters in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNumPages">
|
|
<summary>
|
|
The number of pages in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldNumWords">
|
|
<summary>
|
|
The number of words in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldOCX">
|
|
<summary>
|
|
Represents an ActiveX control such as a command button etc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldPage">
|
|
<summary>
|
|
Insert the number of the current page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldPageRef">
|
|
<summary>
|
|
Insert the number of the page containing the specified bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldPrint">
|
|
<summary>
|
|
Download commands to a printer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldPrintDate">
|
|
<summary>
|
|
The date the document was last printed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldPrivate">
|
|
<summary>
|
|
Stores data for documents converted from other file formats.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldQuote">
|
|
<summary>
|
|
Insert literal text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldRef">
|
|
<summary>
|
|
Insert the text marked by a bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldRefDoc">
|
|
<summary>
|
|
Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldRevisionNum">
|
|
<summary>
|
|
Insert the number of times the document has been saved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSaveDate">
|
|
<summary>
|
|
The date the document was last saved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSection">
|
|
<summary>
|
|
Insert the number of the current section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSectionPages">
|
|
<summary>
|
|
Insert the total number of pages in the section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSequence">
|
|
<summary>
|
|
Insert an automatic sequence number.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSet">
|
|
<summary>
|
|
Assign new text to a bookmark.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSkipIf">
|
|
<summary>
|
|
Conditionally skip a record in a mail merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldStyleRef">
|
|
<summary>
|
|
Insert the text from a like-style paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSubject">
|
|
<summary>
|
|
The document's subject from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSubscriber">
|
|
<summary>
|
|
The document's Subscriber from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldSymbol">
|
|
<summary>
|
|
Insert a special character
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTemplate">
|
|
<summary>
|
|
The name of the template attached to the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTime">
|
|
<summary>
|
|
The current time.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTitle">
|
|
<summary>
|
|
The document's title from Summary Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTOA">
|
|
<summary>
|
|
Create a table of authorities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTOAEntry">
|
|
<summary>
|
|
Make a table of authorities entry.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTOC">
|
|
<summary>
|
|
Create a table of contents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldTOCEntry">
|
|
<summary>
|
|
Make a table of contents entry.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldUserAddress">
|
|
<summary>
|
|
Address from Tools Options User Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldUserInitials">
|
|
<summary>
|
|
Initials form Tools Options User Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldUserName">
|
|
<summary>
|
|
Name from Tools Options User Info.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldShape">
|
|
<summary>
|
|
Specifies Type as Shape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldBidiOutline">
|
|
<summary>
|
|
Specifies Type as BIDIOUTLINE.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldAddressBlock">
|
|
<summary>
|
|
Specifies AddressBlock
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldUnknown">
|
|
<summary>
|
|
Specifies Type as Unknown.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldCannotParse">
|
|
<summary>
|
|
Specifies that the field was unable to be parsed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldGreetingLine">
|
|
<summary>
|
|
Greeting Line field
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldRefNoKeyword">
|
|
<summary>
|
|
Specifies that the field represents a REF field where the keyword has been omitted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMacro">
|
|
<summary>
|
|
Macro Field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldMergeBarcode">
|
|
<summary>
|
|
MergeBarcode Field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldDisplayBarcode">
|
|
<summary>
|
|
DisplayBarcode Field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FieldType.FieldBibliography">
|
|
<summary>
|
|
Represents a bibliography field.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CaptionNumberingFormat">
|
|
<summary>
|
|
Type of Caption Numbering
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionNumberingFormat.Number">
|
|
<summary>
|
|
caption format, Numbers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionNumberingFormat.Roman">
|
|
<summary>
|
|
Roman Numerals
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionNumberingFormat.Alphabetic">
|
|
<summary>
|
|
caption format, Alphabets
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CaptionPosition">
|
|
<summary>
|
|
Position of Image Caption Numbering
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionPosition.AboveImage">
|
|
<summary>
|
|
Above the Image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionPosition.AfterImage">
|
|
<summary>
|
|
Below the image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionPosition.AboveItem">
|
|
<summary>
|
|
Above the Item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CaptionPosition.BelowItem">
|
|
<summary>
|
|
Below the Item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.DocumentViewType">
|
|
<summary>
|
|
Specifies view mode in Microsoft word.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentViewType.None">
|
|
<summary>
|
|
Specifies that the document will be rendered in the default view of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentViewType.PrintLayout">
|
|
<summary>
|
|
Everything that will appear in the printed document appears on the screen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentViewType.OutlineLayout">
|
|
<summary>
|
|
Shows the headings and subheadings in the word document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentViewType.NormalLayout">
|
|
<summary>
|
|
Document appears with a dotted line separating the pages and/or document sections.
|
|
Columns, drawings, headers/footers, footnotes/endnotes, and comments do not appear.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.DocumentViewType.WebLayout">
|
|
<summary>
|
|
Designed to show the word document will look as a web page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ZoomType">
|
|
<summary>
|
|
Specifies zooming type in Microsoft Word.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ZoomType.None">
|
|
<summary>
|
|
Indicates to use the explicit zoom percentage.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ZoomType.FullPage">
|
|
<summary>
|
|
Zoom percentage is automatically recalculated to fit one full page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ZoomType.PageWidth">
|
|
<summary>
|
|
Zoom percentage is automatically recalculated to fit page width.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ZoomType.TextFit">
|
|
<summary>
|
|
Zoom percentage is automatically recalculated to fit text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.LineNumberingRestartMode">
|
|
<summary>
|
|
Specifies when line numbering is restarted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineNumberingRestartMode.RestartPage">
|
|
<summary>
|
|
Line numbering restarts at the start of every page
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineNumberingRestartMode.RestartSection">
|
|
<summary>
|
|
Line numbering restarts at the section start.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineNumberingRestartMode.Continuous">
|
|
<summary>
|
|
Line numbering continuous from the previous section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineNumberingRestartMode.None">
|
|
<summary>
|
|
None.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PageBordersApplyType">
|
|
<summary>
|
|
Specifies on which pages border is applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PageBordersApplyType.AllPages">
|
|
<summary>
|
|
Page border applies to all pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PageBordersApplyType.FirstPage">
|
|
<summary>
|
|
Page border applies only to first pages.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PageBordersApplyType.AllExceptFirstPage">
|
|
<summary>
|
|
Page border applies to all pages except the first.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PageBorderOffsetFrom">
|
|
<summary>
|
|
Specifies the position of page border.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PageBorderOffsetFrom.Text">
|
|
<summary>
|
|
Page border is measured from text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PageBorderOffsetFrom.PageEdge">
|
|
<summary>
|
|
Page border is measured from the edge of the page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.TextEffect">
|
|
<summary>
|
|
Animation effect for text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.None">
|
|
<summary>
|
|
specifies no animation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.LasVegasLights">
|
|
<summary>
|
|
Specifies that this text shall be surrounded by a border consisting of a series of
|
|
colored lights, which constantly change colors in sequence.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.BlinkingBackground">
|
|
<summary>
|
|
Specifies that this text shall be surrounded by a background
|
|
color which alternates between black and white.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.SparkleText">
|
|
<summary>
|
|
Specifies that this text shall have a background consisting of a random pattern of
|
|
colored lights, which constantly change colors in sequence.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.MarchingBlackAnts">
|
|
<summary>
|
|
Specifies that this text shall be surrounded by an animated black dashed line border.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.MarchingRedAnts">
|
|
<summary>
|
|
Specifies that this text shall be surrounded by an animated red dashed line border.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextEffect.Shimmer">
|
|
<summary>
|
|
Specifies that this text shall be animated by alternating between normal and blurry states.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.OutlineLevel">
|
|
<summary>
|
|
The enum, which defines paragraph format's outline level
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level1">
|
|
<summary>
|
|
Outline level: "Level 1"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level2">
|
|
<summary>
|
|
Outline level: "Level 2"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level3">
|
|
<summary>
|
|
Outline level: "Level 3"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level4">
|
|
<summary>
|
|
Outline level: "Level 4"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level5">
|
|
<summary>
|
|
Outline level: "Level 5"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level6">
|
|
<summary>
|
|
Outline level: "Level 6"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level7">
|
|
<summary>
|
|
Outline level: "Level 7"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level8">
|
|
<summary>
|
|
Outline level: "Level 8"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Level9">
|
|
<summary>
|
|
Outline level: "Level 9"
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.OutlineLevel.Body">
|
|
<summary>
|
|
Outline level: "Body"
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.HorizontalRelation">
|
|
<summary>
|
|
The enum defines the horizontal relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalRelation.Column">
|
|
<summary>
|
|
The "Column" horizontal relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalRelation.Margin">
|
|
<summary>
|
|
The "Margin" horizontal relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalRelation.Page">
|
|
<summary>
|
|
The "Page" horizontal relation
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.VerticalRelation">
|
|
<summary>
|
|
The enum defines the vertical relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalRelation.Margin">
|
|
<summary>
|
|
The "Margin" vertical relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalRelation.Page">
|
|
<summary>
|
|
The "Page" vertical relation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalRelation.Paragraph">
|
|
<summary>
|
|
The "Paragraph" vertical relation
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.HorizontalPosition">
|
|
<summary>
|
|
Specifies the absolute horizontal position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.None">
|
|
<summary>
|
|
Horizontal Position is null
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Left">
|
|
<summary>
|
|
The object is aligned to the left of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Center">
|
|
<summary>
|
|
The object is centered to the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Right">
|
|
<summary>
|
|
The object is aligned to the right of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Inside">
|
|
<summary>
|
|
"Inside" horizontal position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Outside">
|
|
<summary>
|
|
"Outside" horizontal position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Inline">
|
|
<summary>
|
|
Represents an inline horizontal position
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.HorizontalPosition.Default">
|
|
<summary>
|
|
Represents the default horizontal position
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.VerticalPosition">
|
|
<summary>
|
|
Specifies the absolute vertical position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.None">
|
|
<summary>
|
|
No vertical positioning
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Top">
|
|
<summary>
|
|
"Top" vertical position
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Center">
|
|
<summary>
|
|
"Center" vertical position
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Bottom">
|
|
<summary>
|
|
"Bottom" vertical position
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Inside">
|
|
<summary>
|
|
"Inside" vertical position
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Outside">
|
|
<summary>
|
|
"Outside" vertical position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Inline">
|
|
<summary>
|
|
"Inline" vertical position.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.VerticalPosition.Default">
|
|
<summary>
|
|
Same as <see cref="F:Spire.Doc.VerticalPosition.None"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.LineDashing">
|
|
<summary>
|
|
Line dashing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.Solid">
|
|
<summary>
|
|
Solid (continuous) pen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.Dash">
|
|
<summary>
|
|
PS_DASH system dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.Dot">
|
|
<summary>
|
|
PS_DOT system dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.DashDot">
|
|
<summary>
|
|
PS_DASHDOT system dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.DashDotDot">
|
|
<summary>
|
|
PS_DASHDOTDOT system dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.DotGEL">
|
|
<summary>
|
|
Square dot style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.DashGEL">
|
|
<summary>
|
|
Dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.LongDashGEL">
|
|
<summary>
|
|
Long dash style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.DashDotGEL">
|
|
<summary>
|
|
Dash short dash.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.LongDashDotGEL">
|
|
<summary>
|
|
Long dash short dash.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.LongDashDotDotGEL">
|
|
<summary>
|
|
Long dash short dash short dash.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineDashing.Default">
|
|
<summary>
|
|
Same as <see cref="F:Spire.Doc.LineDashing.Solid"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.WrapMode">
|
|
<summary>
|
|
Specifies Wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.Square">
|
|
<summary>
|
|
Square wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.ByPoints">
|
|
<summary>
|
|
ByPoints wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.None">
|
|
<summary>
|
|
No wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.TopBottom">
|
|
<summary>
|
|
TopBottom wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.Through">
|
|
<summary>
|
|
Through wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.WrapMode.Inline">
|
|
<summary>
|
|
Inline wrap mode.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PropertyValueType">
|
|
<summary>
|
|
Specifies PropertyValueType.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Boolean">
|
|
<summary>
|
|
Specifies Value type as boolean.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Date">
|
|
<summary>
|
|
Specifies Value type as date.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Float">
|
|
<summary>
|
|
Specifies Value type as float.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Double">
|
|
<summary>
|
|
Specifies Value type as double.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Int">
|
|
<summary>
|
|
Specifies Value type as integer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Int32">
|
|
<summary>
|
|
Represents a 32-bit signed integer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.String">
|
|
<summary>
|
|
Specifies Value type as String.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.ByteArray">
|
|
<summary>
|
|
Specifies Value type as byte array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.StringArray">
|
|
<summary>
|
|
The property is an array of strings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.ObjectArray">
|
|
<summary>
|
|
The property is an array of objects.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.ClipData">
|
|
<summary>
|
|
Specifies Value type as ClipData.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.AsciiString">
|
|
<summary>
|
|
The property is string composed of ASCII characters only.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyValueType.Other">
|
|
<summary>
|
|
The property is some other type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.PropertyType">
|
|
<summary>
|
|
Specifies Type of the Property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyType.Summary">
|
|
<summary>
|
|
Specifies Property Type as Summary.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyType.DocumentSummary">
|
|
<summary>
|
|
Specifies Property Type as DocumentSummary.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.PropertyType.Custom">
|
|
<summary>
|
|
Specifies Property Type as Custom.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.LineSpacingRule">
|
|
<summary>
|
|
Paragraph line spacing rule
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineSpacingRule.AtLeast">
|
|
<summary>
|
|
The line spacing can be greater than or equal to, but never less than,
|
|
the value specified in the LineSpacing property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineSpacingRule.Exactly">
|
|
<summary>
|
|
The line spacing never changes from the value specified in the LineSpacing property,
|
|
even if a larger font is used within the paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LineSpacingRule.Multiple">
|
|
<summary>
|
|
The line spacing is specified in the LineSpacing property as the number of lines.
|
|
One line equals 12 points.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ShapeHorizontalAlignment">
|
|
<summary>
|
|
Specifies horizontal alignment of a floating shape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.None">
|
|
<summary>
|
|
The object is explicitly positioned using position properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Left">
|
|
<summary>
|
|
The object is aligned to the left of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Center">
|
|
<summary>
|
|
The object is centered to the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Right">
|
|
<summary>
|
|
The object is aligned to the right of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Inside">
|
|
<summary>
|
|
Not documented.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Outside">
|
|
<summary>
|
|
Not documented.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeHorizontalAlignment.Default">
|
|
<summary>
|
|
Same as <see cref="F:Spire.Doc.ShapeHorizontalAlignment.None"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.ShapeVerticalAlignment">
|
|
<summary>
|
|
Specifies vertical alignment of a floating shape.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Inline">
|
|
<summary>
|
|
Not documented.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.None">
|
|
<summary>
|
|
The object is explicitly positioned using position properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Top">
|
|
<summary>
|
|
The object is aligned to the top of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Center">
|
|
<summary>
|
|
The object is centered relative to the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Bottom">
|
|
<summary>
|
|
The object is aligned to the bottom of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Inside">
|
|
<summary>
|
|
Not documented.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Outside">
|
|
<summary>
|
|
Not documented.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.ShapeVerticalAlignment.Default">
|
|
<summary>
|
|
Same as <see cref="F:Spire.Doc.ShapeVerticalAlignment.None"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.TextAnchor">
|
|
<summary>
|
|
Specifies vertical alignment of a textbox.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextAnchor.Top">
|
|
<summary>
|
|
The object is aligned to the top of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextAnchor.Center">
|
|
<summary>
|
|
The object is centered relative to the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextAnchor.Bottom">
|
|
<summary>
|
|
The object is aligned to the bottom of the reference origin.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.TextFormFieldType">
|
|
<summary>
|
|
Specifies the type of a text form field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.RegularText">
|
|
<summary>
|
|
Text form field can contain any text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.NumberText">
|
|
<summary>
|
|
Text form field can contain only numbers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.DateText">
|
|
<summary>
|
|
Text for field can contain only a valid date value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.CurrentDate">
|
|
<summary>
|
|
The text form field value is the current date when the field is updated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.CurrentTime">
|
|
<summary>
|
|
The text form field value is the current time when the field is updated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.TextFormFieldType.Calculation">
|
|
<summary>
|
|
The text form field value is calculated from the expression specified in
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootnotePosition">
|
|
<summary>
|
|
Specifies FootnotePosition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnotePosition.PrintAsEndOfSection">
|
|
<summary>
|
|
Endnotes are output at the end of the section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnotePosition.PrintAtBottomOfPage">
|
|
<summary>
|
|
Footnotes are output at the bottom of each page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnotePosition.PrintImmediatelyBeneathText">
|
|
<summary>
|
|
Footnotes are output beneath text on each page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnotePosition.PrintAsEndOfDocument">
|
|
<summary>
|
|
Endnotes are output at the end of the document. Valid for endnotes only.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootnoteRestartRule">
|
|
<summary>
|
|
Specifies FootnoteRestartIndex.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteRestartRule.DoNotRestart">
|
|
<summary>
|
|
Numbering continuous throughout the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteRestartRule.RestartSection">
|
|
<summary>
|
|
Numbering restarts at each section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteRestartRule.RestartPage">
|
|
<summary>
|
|
Numbering restarts at each page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteRestartRule.Default">
|
|
<summary>
|
|
Equals <see cref="F:Spire.Doc.FootnoteRestartRule.DoNotRestart"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.EndnotePosition">
|
|
<summary>
|
|
Endnote position of the Document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.EndnotePosition.DisplayEndOfSection">
|
|
<summary>
|
|
Placed the Endnote on End of the section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.EndnotePosition.DisplayEndOfDocument">
|
|
<summary>
|
|
Placed the Endnote on End of the Document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootnoteNumberFormat">
|
|
<summary>
|
|
Specifies Numberformat of FootEndNote.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Arabic">
|
|
<summary>
|
|
Arabic format (1, 2, 3, ...).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.UpperCaseRoman">
|
|
<summary>
|
|
Upper case Roman format (I, II, III, ...) .
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.LowerCaseRoman">
|
|
<summary>
|
|
Lower case Roman format (i, ii, iii, ...) .
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.UpperCaseLetter">
|
|
<summary>
|
|
Upper case letters format (A, B, C, ...) .
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.LowerCaseLetter">
|
|
<summary>
|
|
Lower case letters format (a, b, c, ...) .
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Chicago">
|
|
<summary>
|
|
Chicago manual of style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Kanji">
|
|
<summary>
|
|
Ideograph-digital
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.KanjiDigit">
|
|
<summary>
|
|
Japanese counting
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.AiueoHalfWidth">
|
|
<summary>
|
|
Aiueo
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.IrohaHalfWidth">
|
|
<summary>
|
|
Iroha
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.DecimalFullWidth">
|
|
<summary>
|
|
Specifies that the sequence shall consist of full-width Arabic numbering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.DecimalHalfWidth">
|
|
<summary>
|
|
Half-width Arabic: 1, 2, 3, 4
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.KanjiTraditional">
|
|
<summary>
|
|
Japanese legal
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.KanjiTraditional2">
|
|
<summary>
|
|
Japanese digital ten thousand
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.NumberInCircle">
|
|
<summary>
|
|
Enclosed circles
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Chosung">
|
|
<summary>
|
|
Korea Chosung
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Ganada">
|
|
<summary>
|
|
Korean Ganada
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.GB1">
|
|
<summary>
|
|
Enclosed full stop
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.GB2">
|
|
<summary>
|
|
Enclosed parenthesis
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.DecimalEnclosedCircleChinese">
|
|
<summary>
|
|
Identical to DecimalEnclosedCircle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.IdeographEnclosedCircle">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.IdeographTraditional">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical traditional ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.IdeographZodiac">
|
|
<summary>
|
|
Specifies that the sequence shall consist of sequential numerical zodiac ideographs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Zodiac3">
|
|
<summary>
|
|
Ideograph Zodiac traditional
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Hebrew1">
|
|
<summary>
|
|
Specifies that the sequence shall consist of Hebrew letters from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.Hebrew2">
|
|
<summary>
|
|
Specifies that the sequence shall consist of the Hebrew alphabet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.ArabicAlpha">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single character int the Arabic alphabet from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.ArabicAbjad">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single ascending Abjad numerall from the set listed below.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.ChineseLegalSimplified">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single sequential number from the Chinese simplified legal format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.ChineseCountingThousand">
|
|
<summary>
|
|
Specifies that the sequence shall consist of one or more occurrences of
|
|
a single sequential number from the Chinese counting thousand system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteNumberFormat.None">
|
|
<summary>
|
|
number format is none
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FootnoteType">
|
|
<summary>
|
|
Specifies the Type of the FootNote.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteType.Footnote">
|
|
<summary>
|
|
Specifies object is a footnote.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FootnoteType.Endnote">
|
|
<summary>
|
|
Specifies object is a endnote.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.LocaleIDs">
|
|
<summary>
|
|
Represents different locale IDs for various languages and regions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.LanguageNotSet">
|
|
<summary>
|
|
Represents a scenario where the language has not been set or specified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.Japanese">
|
|
<summary>
|
|
Represents the language for Japanese.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.Korean">
|
|
<summary>
|
|
Represents the language for Korean.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.x_none">
|
|
<summary>
|
|
Represents a placeholder or absence of a specific value
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.af_ZA">
|
|
<summary>
|
|
Represents the Afrikaans language as spoken in South Africa.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sq_AL">
|
|
<summary>
|
|
Represents the Albanian language (sq) as spoken in Albania (AL).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.am_ET">
|
|
<summary>
|
|
Represents the Amharic language used in Ethiopia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.gsw_FR">
|
|
<summary>
|
|
Represents the Swiss German as used in France.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_DZ">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Algeria.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_BH">
|
|
<summary>
|
|
Arabic (Bahrain).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_EG">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Egypt.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_IQ">
|
|
<summary>
|
|
Represents the Arabic language (ar) as spoken in Iraq (IQ).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_JO">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Jordan.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_KW">
|
|
<summary>
|
|
Represents the Arabic language as used in Kuwait (ar_KW).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_LB">
|
|
<summary>
|
|
Represents the locale for Lebanese Arabic (ar-LB).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_LY">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Libya.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_MA">
|
|
<summary>
|
|
Arabic (Morocco).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_OM">
|
|
<summary>
|
|
Represents the Arabic language (ar) as spoken in Oman (OM).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_QA">
|
|
<summary>
|
|
Represents the Arabic language (ar) as used in Qatar (QA).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_SA">
|
|
<summary>
|
|
Represents the Arabic language (ar) as spoken in Saudi Arabia (SA).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_SY">
|
|
<summary>
|
|
Arabic (Syria).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_TN">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Tunisia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_AE">
|
|
<summary>
|
|
Represents the Arabic language as spoken in the United Arab Emirates.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ar_YE">
|
|
<summary>
|
|
Represents the Arabic language as spoken in Yemen (ar-YE).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hy_AM">
|
|
<summary>
|
|
Represents the Armenian language as spoken in Armenia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.as_IN">
|
|
<summary>
|
|
Assamese (India)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.az_Cyrl_AZ">
|
|
<summary>
|
|
Represents the Azerbaijani language using Cyrillic script as spoken in Azerbaijan.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.az_Latn_AZ">
|
|
<summary>
|
|
Represents the Azerbaijani language using the Latin alphabet, specifically for Azerbaijan.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ba_RU">
|
|
<summary>
|
|
Bashkir (Russia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.eu_ES">
|
|
<summary>
|
|
Basque (Spain).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.be_BY">
|
|
<summary>
|
|
Belarusian language (Belarus)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bn_BD">
|
|
<summary>
|
|
Bengali in Bangladesh.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bn_IN">
|
|
<summary>
|
|
Represents the locale for Indian National (Bengali) language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bs_Cyrl_BA">
|
|
<summary>
|
|
Represents the Bosnian language using Cyrillic script as used in Bosnia and Herzegovina.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bs_Latn_BA">
|
|
<summary>
|
|
Represents the Bosnian language using the Latin script as spoken in Bosnia and Herzegovina.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bg_BG">
|
|
<summary>
|
|
Bulgarian language (Bulgaria).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.br_FR">
|
|
<summary>
|
|
Breton in France
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.my_MM">
|
|
<summary>
|
|
Burmese Myanmar
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ca_ES">
|
|
<summary>
|
|
Catalan in Spain
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.chr_US">
|
|
<summary>
|
|
Cherokee in USA
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zh_HK">
|
|
<summary>
|
|
Chinese(Hong Kong)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zh_MO">
|
|
<summary>
|
|
Chinese(Macau)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zh_CN">
|
|
<summary>
|
|
Chinese(Simplified)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zh_SG">
|
|
<summary>
|
|
Chinese(Singapore)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zh_TW">
|
|
<summary>
|
|
Chinese(Taiwan)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.co_FR">
|
|
<summary>
|
|
Corsican in France.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hr_BA">
|
|
<summary>
|
|
Croatian used in Bosnia and Herzegovina.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hr_HR">
|
|
<summary>
|
|
Croatian
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.cs_CZ">
|
|
<summary>
|
|
Czech
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.da_DK">
|
|
<summary>
|
|
Represents Danish (Denmark).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.prs_AF">
|
|
<summary>
|
|
Dari Persian in Afghanistan
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.dv_MV">
|
|
<summary>
|
|
Dhivehi in Maldives
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nl_BE">
|
|
<summary>
|
|
Represents the locale for Dutch (Flemish) as spoken in Belgium.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nl_NL">
|
|
<summary>
|
|
Represents the Dutch language as spoken in the Netherlands.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bin_NG">
|
|
<summary>
|
|
Bini in Nigeria
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.et_EE">
|
|
<summary>
|
|
Represents the locale for Estonian (Estonia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_AU">
|
|
<summary>
|
|
Represents the locale for English (Australia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_BZ">
|
|
<summary>
|
|
Represents the English language as used in Belize (en-BZ).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_CA">
|
|
<summary>
|
|
Canadian English
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_029">
|
|
<summary>
|
|
Caribbean English
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_HK">
|
|
<summary>
|
|
Represents the English language as used in Hong Kong.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_IN">
|
|
<summary>
|
|
Represents the locale for English as used in India.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_ID">
|
|
<summary>
|
|
English in Indonesia
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_IE">
|
|
<summary>
|
|
Represents the locale for English (Ireland).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_JM">
|
|
<summary>
|
|
Represents the English language as spoken in Jamaica.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_MY">
|
|
<summary>
|
|
Malaysian English
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_NZ">
|
|
<summary>
|
|
Represents the New Zealand English.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_PH">
|
|
<summary>
|
|
Represents the Filipino language (Filipino) as spoken in the Philippines.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_SG">
|
|
<summary>
|
|
Represents the English language as used in Singapore.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_ZA">
|
|
<summary>
|
|
Represents the locale for English (South Africa).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_TT">
|
|
<summary>
|
|
Represents the English language as spoken in Trinidad and Tobago.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_GB">
|
|
<summary>
|
|
Represents the locale for English as used in the United Kingdom.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_US">
|
|
<summary>
|
|
English (United States).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.en_ZW">
|
|
<summary>
|
|
Represents the locale for Zimbabwe, using English as the language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fo_FO">
|
|
<summary>
|
|
Represents the Faroese language (fo) as used in Faroe Islands (FO).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fil_PH">
|
|
<summary>
|
|
Philippines
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fi_FI">
|
|
<summary>
|
|
Represents the Finnish language (Finland).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_BE">
|
|
<summary>
|
|
Represents the locale for French (Belgium).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_CM">
|
|
<summary>
|
|
Represents the locale for French (France) as used in Cameroon.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_CA">
|
|
<summary>
|
|
Represents the Canadian French language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_CD">
|
|
<summary>
|
|
French (France) in Democratic Republic of Congo.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_CI">
|
|
<summary>
|
|
Ivoiran French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_FR">
|
|
<summary>
|
|
French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_HT">
|
|
<summary>
|
|
Haitian French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_LU">
|
|
<summary>
|
|
Luxembourgish French.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_ML">
|
|
<summary>
|
|
Malian French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_MC">
|
|
<summary>
|
|
French (Monaco)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_MA">
|
|
<summary>
|
|
Moroccan French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_RE">
|
|
<summary>
|
|
Réunion French
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_SN">
|
|
<summary>
|
|
Represents the French language as spoken in Senegal (fr_SN).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_CH">
|
|
<summary>
|
|
Swiss French.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fr_fr_WINDIES">
|
|
<summary>
|
|
French in West Indies
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fy_NL">
|
|
<summary>
|
|
Represents the language code for Dutch (Netherlands).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ff_NG">
|
|
<summary>
|
|
Represents the language code for Filipino (Philippines).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.gd_GB">
|
|
<summary>
|
|
Scottish Gaelic(United Kingdom)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.gl_ES">
|
|
<summary>
|
|
Galician in Spain.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ka_GE">
|
|
<summary>
|
|
Represents the Georgian language (ka) as used in Georgia (GE).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.de_AT">
|
|
<summary>
|
|
Austrian German
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.de_DE">
|
|
<summary>
|
|
German
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.de_LI">
|
|
<summary>
|
|
Liechtenstein German
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.de_LU">
|
|
<summary>
|
|
Luxembourgish German.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.de_CH">
|
|
<summary>
|
|
Swiss German
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.el_GR">
|
|
<summary>
|
|
Greek
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.gn_PY">
|
|
<summary>
|
|
Represents the locale for Guarani (Paraguay).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.gu_IN">
|
|
<summary>
|
|
Gujarati in India.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.kl_GL">
|
|
<summary>
|
|
Kalaallisut in Greenland
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ha_Latn_NG">
|
|
<summary>
|
|
Represents the locale for Hausa language using Latin script as spoken in Nigeria.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.haw_US">
|
|
<summary>
|
|
Hawaiian the United States
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.he_IL">
|
|
<summary>
|
|
Hebrew in Israel
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hi_IN">
|
|
<summary>
|
|
Hindi (India).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hu_HU">
|
|
<summary>
|
|
Hungarian (Hungary).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ibb_NG">
|
|
<summary>
|
|
Igbo in Nigeria
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.is_IS">
|
|
<summary>
|
|
Icelandic
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ig_NG">
|
|
<summary>
|
|
Represents the Nigerian locale, specifically for Nigeria using the Igbo language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.id_ID">
|
|
<summary>
|
|
Indonesian (Bahasa Indonesia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.iu_Latn_CA">
|
|
<summary>
|
|
Inuktitut, following the Latin alphabet writing system, is used in Canada.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.iu_Cans_CA">
|
|
<summary>
|
|
Inuktitut, used in Canada, is written in Inuktitut syllabics.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.it_IT">
|
|
<summary>
|
|
Italian
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.it_CH">
|
|
<summary>
|
|
Swiss Italian
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ga_IE">
|
|
<summary>
|
|
Represents the locale for Irish (Gaelic) as spoken in Ireland.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.xh_ZA">
|
|
<summary>
|
|
Represents the locale for Xhosa language spoken in South Africa.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.zu_ZA">
|
|
<summary>
|
|
Represents the locale for Afrikaans (South Africa).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.kn_IN">
|
|
<summary>
|
|
Kannada in Indian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.kr_NG">
|
|
<summary>
|
|
Kanuri in Nigeria
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ks_Deva">
|
|
<summary>
|
|
Kashmiri written by Devanagari script
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ks_Arab">
|
|
<summary>
|
|
Kashmiri written by Arabic script
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.kk_KZ">
|
|
<summary>
|
|
Represents the Kazakh language as spoken in Kazakhstan
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.km_KH">
|
|
<summary>
|
|
Represents the locale for Khmer (Khmer) as used in Cambodia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.kok_IN">
|
|
<summary>
|
|
Indian Konkani language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ko_KR">
|
|
<summary>
|
|
Korean (South Korea)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ky_KG">
|
|
<summary>
|
|
Kyrgyz (Kyrgyzstan).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.qut_GT">
|
|
<summary>
|
|
K'iche' in Guatemala
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.rw_RW">
|
|
<summary>
|
|
Represents the locale for Rwanda using the Kinyarwanda language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.lo_LA">
|
|
<summary>
|
|
Lao
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.la_Latn">
|
|
<summary>
|
|
Latin language.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.lv_LV">
|
|
<summary>
|
|
Represents the locale for Latvian (Latvia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.lt_LT">
|
|
<summary>
|
|
Represents the locale for Lithuanian (Lithuania).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.dsb_DE">
|
|
<summary>
|
|
Lower Sorbian in Germany
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.lb_LU">
|
|
<summary>
|
|
Luxembourgish
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mk_MK">
|
|
<summary>
|
|
Represents the locale for Macedonian (North Macedonia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ms_BN">
|
|
<summary>
|
|
Malay in Brunei.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ms_MY">
|
|
<summary>
|
|
Represents the locale for Malay (Bahasa Melayu) as used in Malaysia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ml_IN">
|
|
<summary>
|
|
Malayalam in Indian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mt_MT">
|
|
<summary>
|
|
Represents the locale for Maltese (Malta).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mni_IN">
|
|
<summary>
|
|
Meitei in Indian
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mi_NZ">
|
|
<summary>
|
|
Maori in New Zealand
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mr_IN">
|
|
<summary>
|
|
Marathi (mr) as used in India (IN).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.arn_CL">
|
|
<summary>
|
|
Mapudungun in Chile
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mn_MN">
|
|
<summary>
|
|
Mongolian (Mongolia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.mn_Mong_CN">
|
|
<summary>
|
|
Mongolian (China).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ne_NP">
|
|
<summary>
|
|
Nepali (Nepal).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ne_IN">
|
|
<summary>
|
|
Indian, which is used in Nepal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nb_NO">
|
|
<summary>
|
|
Represents the Norwegian (Bokmål) language as spoken in Norway.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nn_NO">
|
|
<summary>
|
|
Nynorsk (Norway).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.oc_FR">
|
|
<summary>
|
|
Occitan language in France
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.or_IN">
|
|
<summary>
|
|
Odia language used in India.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.om_Ethi_ET">
|
|
<summary>
|
|
Oromo (Ethiopia), written by Ethiopic script.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pap_AN">
|
|
<summary>
|
|
Papiamento in Netherlands Antilles
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ps_AF">
|
|
<summary>
|
|
Pashto (Afghanistan).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.fa_IR">
|
|
<summary>
|
|
Persian in Iran
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pl_PL">
|
|
<summary>
|
|
Polish (Poland)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pt_BR">
|
|
<summary>
|
|
Brazilian Portuguese (Brazil)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pt_PT">
|
|
<summary>
|
|
European Portuguese (Portugal)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pa_IN">
|
|
<summary>
|
|
Punjabi (India)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.pa_PK">
|
|
<summary>
|
|
Punjabi in Pakistan
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.quz_BO">
|
|
<summary>
|
|
Southern Quechua (Bolivia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.guz_EC">
|
|
<summary>
|
|
Gusii (Ecuador)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.guz_PE">
|
|
<summary>
|
|
Gusii (Peru)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ro_RO">
|
|
<summary>
|
|
Romanian (Romania).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ro_MO">
|
|
<summary>
|
|
Romanian (Moldova)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.rm_CH">
|
|
<summary>
|
|
Romansh (Switzerland)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ru_RU">
|
|
<summary>
|
|
Russian (Russia)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ru_MO">
|
|
<summary>
|
|
Russian (Moldova).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.smn_FI">
|
|
<summary>
|
|
Inari Sami (Finland)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.smj_NO">
|
|
<summary>
|
|
Lule Sami (Norway)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.smj_SE">
|
|
<summary>
|
|
Lule Sami (Sweden)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.se_FI">
|
|
<summary>
|
|
Northern Sami (Finland).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.se_NO">
|
|
<summary>
|
|
Northern Sami (Norway).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.se_SE">
|
|
<summary>
|
|
Northern Sami(Sweden).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sms_FI">
|
|
<summary>
|
|
Skolt Sami (Finland)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sma_NO">
|
|
<summary>
|
|
Southern Sami(Norway).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sma_SE">
|
|
<summary>
|
|
Southern Sami(Sweden).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sa_IN">
|
|
<summary>
|
|
Sanskrit (India)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sr_Cyrl_BA">
|
|
<summary>
|
|
Represents the Serbian language using Cyrillic script for Bosnia and Herzegovina.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sr_Cyrl_CS">
|
|
<summary>
|
|
Represents the Serbian language using Cyrillic script as spoken in Serbia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sr_Latn_BA">
|
|
<summary>
|
|
Represents the Serbian language using Latin script for Bosnia and Herzegovina.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sr_Latn_CS">
|
|
<summary>
|
|
Represents the Serbian language using Latin script and the Cyrillic script as used in Serbia.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nso_ZA">
|
|
<summary>
|
|
Northern Sotho (South Africa)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tn_ZA">
|
|
<summary>
|
|
Tswana (South African).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sd_Arab_PK">
|
|
<summary>
|
|
Sindhi (Pakistan), using Arabic alphabet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sd_Deva_IN">
|
|
<summary>
|
|
Sindhi (India), using Devanagari script.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.si_LK">
|
|
<summary>
|
|
Sinhala (Sri Lanka).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sk_SK">
|
|
<summary>
|
|
Slovak language (Slovakia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sl_SI">
|
|
<summary>
|
|
Slovenian (Slovenia).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.so_SO">
|
|
<summary>
|
|
Somali
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_AR">
|
|
<summary>
|
|
Spanish (Argentina)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_BO">
|
|
<summary>
|
|
Spanish (Bolivia)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_CL">
|
|
<summary>
|
|
Spanish (Chile)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_CO">
|
|
<summary>
|
|
Spanish (Colombia)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_CR">
|
|
<summary>
|
|
Spanish (Costa Rica)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_DO">
|
|
<summary>
|
|
Spanish (Dominican Republic)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_EC">
|
|
<summary>
|
|
Spanish (Ecuador)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_SV">
|
|
<summary>
|
|
Spanish (El Salvador)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_GT">
|
|
<summary>
|
|
Spanish (Guatemala)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_HN">
|
|
<summary>
|
|
Spanish (Honduras)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_MX">
|
|
<summary>
|
|
Spanish (Mexico)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_NI">
|
|
<summary>
|
|
Spanish (Nicaragua)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_PA">
|
|
<summary>
|
|
Spanish (Panama)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_PY">
|
|
<summary>
|
|
Spanish (Paraguay)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_PE">
|
|
<summary>
|
|
Spanish (Paraguay
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_PR">
|
|
<summary>
|
|
Spanish (Puerto Rico)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_ES">
|
|
<summary>
|
|
Spanish (International Sort)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_ES_tradnl">
|
|
<summary>
|
|
Spanish(Spain Traditional Sort)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_US">
|
|
<summary>
|
|
Spanish(United Sates)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_UY">
|
|
<summary>
|
|
Spanish (Uruguay)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.es_VE">
|
|
<summary>
|
|
Spanish (Venezuela)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.st_ZA">
|
|
<summary>
|
|
Sutu
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sw_KE">
|
|
<summary>
|
|
Swahili
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sv_FI">
|
|
<summary>
|
|
Swedish (Finland)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sv_SE">
|
|
<summary>
|
|
Swedish (Sweden)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.syr_SY">
|
|
<summary>
|
|
Syriac
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tg_Cyrl_TJ">
|
|
<summary>
|
|
Tajik
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tzm_Arab_MA">
|
|
<summary>
|
|
Tamazight
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tzm_Latn_DZ">
|
|
<summary>
|
|
Tamazight (Latin)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ta_IN">
|
|
<summary>
|
|
Tamil
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tt_RU">
|
|
<summary>
|
|
Tatar
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.te_IN">
|
|
<summary>
|
|
Telugu
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.th_TH">
|
|
<summary>
|
|
Thai
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bo_CN">
|
|
<summary>
|
|
Tibetan (PRC)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ti_ER">
|
|
<summary>
|
|
Tigrigna (Eritrea)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ti_ET">
|
|
<summary>
|
|
Tigrigna (Ethiopia)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ts_ZA">
|
|
<summary>
|
|
Tsonga
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tr_TR">
|
|
<summary>
|
|
Turkish
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.tk_TM">
|
|
<summary>
|
|
Turkmen
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ug_CN">
|
|
<summary>
|
|
Uyghur in China
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.uk_UA">
|
|
<summary>
|
|
Ukrainian
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.hsb_DE">
|
|
<summary>
|
|
Represents Upper Sorbian in German
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ur_PK">
|
|
<summary>
|
|
Urdu
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.uz_Cyrl_UZ">
|
|
<summary>
|
|
Uzbek (Cyrillic)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.uz_Latn_UZ">
|
|
<summary>
|
|
Uzbek (Latin)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ve_ZA">
|
|
<summary>
|
|
Venda
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.vi_VN">
|
|
<summary>
|
|
Vietnamese
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.cy_GB">
|
|
<summary>
|
|
Welsh
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.wo_SN">
|
|
<summary>
|
|
Wolof in Senegal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.sah_RU">
|
|
<summary>
|
|
Sakha/Yakut in Russian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ii_CN">
|
|
<summary>
|
|
Yi
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.yi_Hebr">
|
|
<summary>
|
|
Yiddish
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.yo_NG">
|
|
<summary>
|
|
Yoruba
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.ja_JP">
|
|
<summary>
|
|
Japanese
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.moh_CA">
|
|
<summary>
|
|
Mohawk in Canada
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.quz_EC">
|
|
<summary>
|
|
Quechua in Ecuador
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.quz_PE">
|
|
<summary>
|
|
Quechua in Peru
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.bo_BT">
|
|
<summary>
|
|
Represents the locale for Bo (Tibetan) as used in Bhutan.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LocaleIDs.nl">
|
|
<summary>
|
|
Dutch
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CellWidthType">
|
|
<summary>
|
|
Specifies preferred width type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CellWidthType.Auto">
|
|
<summary>
|
|
No preferred width is specified.
|
|
The width is derived from other table measurements where a preferred size is specified,
|
|
as well as from the size of the table contents, and the constraining size of the
|
|
container of the table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CellWidthType.Percentage">
|
|
<summary>
|
|
Preferred table width specified in percentage
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CellWidthType.Point">
|
|
<summary>
|
|
Preferred table width specified in points
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.LayoutType">
|
|
<summary>
|
|
This simple type defines the possible type of layout algorthms which can be used
|
|
to layout a table within a WordprocessingML document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LayoutType.Fixed">
|
|
<summary>
|
|
Specifies that this table shall use the fixed width table layout algorithm
|
|
described above.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.LayoutType.AutoFit">
|
|
<summary>
|
|
Specifies that this table shall use an AutoFit table layout algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.CharacterSpacing">
|
|
<summary>
|
|
Character Spacing Control enum.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CharacterSpacing.doNotCompress">
|
|
<summary>
|
|
Don't compress punctuation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CharacterSpacing.compressPunctuation">
|
|
<summary>
|
|
Compress punctuation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.CharacterSpacing.compressPunctuationAndJapaneseKana">
|
|
<summary>
|
|
Compress punctuation and japanese kana.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.FrameSizeRule">
|
|
<summary>
|
|
Frame size rule.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FrameSizeRule.AtLeast">
|
|
<summary>
|
|
Frame's height should be at least the value of the h attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FrameSizeRule.Exact">
|
|
<summary>
|
|
Frame's width or height should be exactly the value of the w or h attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.FrameSizeRule.Auto">
|
|
<summary>
|
|
Frame's width or height should be automatically.The w or h value is ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.Doc.BookmarkTextStyle">
|
|
<summary>
|
|
Allows to choose outline text style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.BookmarkTextStyle.Regular">
|
|
<summary>
|
|
Regular text style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.BookmarkTextStyle.Italic">
|
|
<summary>
|
|
Italic text style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Spire.Doc.BookmarkTextStyle.Bold">
|
|
<summary>
|
|
Bold text style.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.PSModel.Core.Rendering.Metafiles.Regions.GeometryRegionData">
|
|
<summary>
|
|
A class that holds two geometry regions and a graphics path.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:Spire.PSModel.Core.Rendering.Metafiles.Regions.GeometryRegionData.#ctor(Spire.PSModel.Core.Rendering.Metafiles.Regions.GeometryRegion,Spire.PSModel.Core.Rendering.Metafiles.Regions.GeometryRegion,Spire.PSModel.Core.Rendering.Ps.PsGraphicsPath)" -->
|
|
<member name="M:Spire.PSModel.Core.Rendering.Pdf.LogicalStructure.PdfLogicalStructureBuilder.StartCompositeCell(Spire.PSModel.Core.Rendering.Ps.LogicalStructure.LogicalStructureTableCell)">
|
|
<summary>
|
|
Begins a composite cell by creating a PdfStructureCell from the provided LogicalStructureTableCell,
|
|
adding it as a child to the current element, and pushing it onto the element tree stack.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Spire.PSModel.Core.Rendering.Ps.IPsRenderTransform">
|
|
<summary>
|
|
Represents an interface for managing render transforms
|
|
</summary>
|
|
</member>
|
|
<member name="P:Spire.PSModel.Core.Rendering.Ps.IPsRenderTransform.RenderTransform">
|
|
<summary>
|
|
Gets or sets the render transform matrix
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|
