|
List of all ONLYOFFICE Document Builder classes and methods
Name |
Description |
CloseFile |
Close the file to stop working with it. You can use a single ONLYOFFICE Document Builder instance to work with all your files, but you need to close the previous file before you can start working with the next one in this case. |
CreateFile |
Create a new file. The type of the file which will be created needs to be set. |
Dispose |
Unloading the ONLYOFFICE Document Builder from the application memory when it is no longer needed. |
ExecuteCommand |
Execute the command which will be used to create the document file (text document, spreadsheet, PDF, etc.).
See the Text document API and Spreadsheet API sections for more information which commands are available for various document types.
|
Initialize |
Initializing the ONLYOFFICE Document Builder as a library for the application to be able to work with it. |
OpenFile |
Open the document file which will be edited and saved afterwards. |
Run |
Run ONLYOFFICE Document Builder executable. If you do not want to write a C++ application, you can simply use the docbuilder.exe executable file and run it with the .docbuilder file as an argument, where all the code for the document file creation will be written. For C++ the path to the executable file from the sPath parameter must be used, the CDocBuilder object created and the Run method is called. |
RunTextA |
Run the all the commands for the document creation using a single command. Compared to CDocBuilder.ExecuteCommand where only one command at a time is allowed, CDocBuilder.RunTextA makes it possible to enter all the commands for the document creation at once. |
RunTextW |
Run the all the commands for the document creation using a single command. Compared to CDocBuilder.ExecuteCommand where only one command at a time is allowed, CDocBuilder.RunTextW makes it possible to enter all the commands for the document creation at once. |
SaveFile |
Save the file after all the changes are made. The type of the file which will be saved needs to be set. |
SetProperty |
The argument which can be trasferred to the program outside the CDocBuilder.ExecuteCommand method. |
SetPropertyW |
The argument which can be trasferred to the program outside the CDocBuilder.ExecuteCommand method. |
SetTmpFolder |
The path to the folder where the program will temporarily save files needed for the program correct work. After the successful document file creation all the files will be deleted from the folder. If no temporary folder is set, the system one will be used. |
Name |
Description |
AddComment |
Adds a comment to the desired element or array of Runs. |
ConvertDocument |
Converts a document to Markdown or HTML text. |
CreateBlipFill |
Creates a blip fill to apply to the object using the selected image as the object background. |
CreateBlockLvlSdt |
Creates a new block level container. |
CreateBullet |
Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter. |
CreateChart |
Creates a chart with the parameters specified. |
CreateGradientStop |
Creates a gradient stop used for different types of gradients. |
CreateHyperlink |
Creates a new hyperlink text block to be inserted to the current paragraph or table. |
CreateImage |
Creates an image with the parameters specified. |
CreateInlineLvlSdt |
Creates a new inline container. |
CreateLinearGradientFill |
Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. |
CreateNoFill |
Creates no fill and removes the fill from the element. |
CreateNumbering |
Creates a bullet for a paragraph with the numbering character or symbol specified with the sType parameter. |
CreateParagraph |
Creates a new paragraph. |
CreatePatternFill |
Creates a pattern fill to apply to the object using the selected pattern as the object background. |
CreatePresetColor |
Creates a color selecting it from one of the available color presets. |
CreateRadialGradientFill |
Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. |
CreateRange |
Creates an element range.
If you do not specify the start and end positions, the range will be taken from the entire element. |
CreateRGBColor |
Creates an RGB color setting the appropriate values for the red, green and blue color components. |
CreateRun |
Creates a new smaller text block to be inserted to the current paragraph or table. |
CreateSchemeColor |
Creates a complex color scheme selecting from one of the available schemes. |
CreateShape |
Creates a shape with the parameters specified. |
CreateSolidFill |
Creates a solid fill to apply to the object using a selected solid color as the object background. |
CreateStroke |
Creates a stroke adding shadows to the element. |
CreateTable |
Creates a new table with a specified number of rows and columns. |
GetDocument |
Returns the main document. |
GetMailMergeReceptionsCount |
Returns the mail merge receptions count. |
GetMailMergeTemplateDocContent |
Returns the mail merge template document. |
LoadMailMergeData |
Loads data for the mail merge. |
MailMerge |
Starts the mail merge process. |
ReplaceDocumentContent |
Replaces the main document content with another document content. |
ReplaceTextSmart |
Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. |
Save |
Saves changes to the specified document. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a block content control to the current container. |
AddText |
Adds a text to the current content control. |
Delete |
Removes a content control and its content. If keepContent is true, the content is not deleted. |
GetAlias |
Returns the alias attribute for the current container. |
GetAllContentControls |
Returns a collection of content control objects in the current content control. |
GetAllDrawingObjects |
Returns a collection of drawing objects in the current content control. |
GetAllParagraphs |
Returns a collection of paragraph objects in the current content control. |
GetAllTablesOnPage |
Returns a collection of tables on a given absolute page.
This method can be a little bit slow, because it runs the document calculation
process to arrange tables on the specified page. |
GetClassType |
Returns a type of the ApiBlockLvlSdt class. |
GetContent |
Returns the content of the current container. |
GetLabel |
Returns the label attribute for the current container. |
GetLock |
Returns the lock type of the current container. |
GetParentContentControl |
Returns a content control that contains the current content control. |
GetParentTable |
Returns a table that contains the current content control. |
GetParentTableCell |
Returns a table cell that contains the current content control. |
GetPlaceholderText |
Returns the placeholder text from the current content control. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified content control. |
GetTag |
Returns the tag attribute for the current container. |
Push |
Pushes a paragraph or a table or a block content control to actually add it to the current container. |
RemoveAllElements |
Clears the contents from the current content control. |
Search |
Searches for a scope of a content control object. The search results are a collection of ApiRange objects. |
Select |
Selects the current content control. |
SetAlias |
Sets the alias attribute to the current container. |
SetLabel |
Sets the label attribute to the current container. |
SetLock |
Sets the lock to the current block text content control:
"contentLocked" - content cannot be edited.
"sdtContentLocked" - content cannot be edited and the container cannot be deleted.
"sdtLocked" - the container cannot be deleted. |
SetPlaceholderText |
Sets the placeholder text to the current content control. |
SetTag |
Sets the tag attribute to the current container. |
SetTextPr |
Applies text settings to the content of the content control. |
Name |
Description |
GetClassType |
Returns a type of the ApiBullet class. |
Name |
Description |
Clear |
Clears the current form. |
GetClassType |
Returns a type of the ApiFormBase class. |
GetFormKey |
Returns the current form key. |
GetFormType |
Returns a type of the current form. |
GetRadioGroup |
Returns the radio group key if the current checkbox is a radio button. |
GetText |
Returns the text from the current form. |
GetTextPr |
Returns the text properties from the current form. |
GetTipText |
Returns the tip text of the current form. |
GetWrapperShape |
Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
The null value will be returned for the inline forms. |
IsChecked |
Returns the state of the current checkbox (checked or not). |
IsFixed |
Checks if the current form is fixed size. |
IsRadioButton |
Checks if the current checkbox is a radio button. |
IsRequired |
Checks if the current form is required. |
SetBackgroundColor |
Sets the background color to the current form. |
SetBorderColor |
Sets the border color to the current form. |
SetChecked |
Checks the current checkbox. |
SetFormKey |
Sets a key to the current form. |
SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
SetRadioGroup |
Sets the radio group key to the current checkbox. |
SetRequired |
Specifies if the current form should be required. |
SetTextPr |
Sets the text properties to the current form. |
SetTipText |
Sets the tip text to the current form. |
ToFixed |
Converts the current form to a fixed size form. |
ToInline |
Converts the current form to an inline form.
Picture form can't be converted to an inline form, it's always a fixed size object. |
Name |
Description |
Clear |
Clears the current form. |
GetClassType |
Returns a type of the ApiFormBase class. |
GetFormKey |
Returns the current form key. |
GetFormType |
Returns a type of the current form. |
GetListValues |
Returns the list values from the current combo box. |
GetText |
Returns the text from the current form. |
GetTextPr |
Returns the text properties from the current form. |
GetTipText |
Returns the tip text of the current form. |
GetWrapperShape |
Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
The null value will be returned for the inline forms. |
IsEditable |
Checks if the combo box text can be edited. |
IsFixed |
Checks if the current form is fixed size. |
IsRequired |
Checks if the current form is required. |
SelectListValue |
Selects the specified value from the combo box list values. |
SetBackgroundColor |
Sets the background color to the current form. |
SetBorderColor |
Sets the border color to the current form. |
SetFormKey |
Sets a key to the current form. |
SetListValues |
Sets the list values to the current combo box. |
SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
SetRequired |
Specifies if the current form should be required. |
SetText |
Sets the text to the current combo box.
Available only for editable combo box forms. |
SetTextPr |
Sets the text properties to the current form. |
SetTipText |
Sets the tip text to the current form. |
ToFixed |
Converts the current form to a fixed size form. |
ToInline |
Converts the current form to an inline form.
Picture form can't be converted to an inline form, it's always a fixed size object. |
Name |
Description |
AcceptAllRevisionChanges |
Accepts all changes made in review mode. |
AddComment |
Adds a comment to the document. |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
ClearAllFields |
Clears all fields in the document. |
ClearAllForms |
Clears all forms in the document. |
CreateNewHistoryPoint |
Creates a new history point. |
CreateNumbering |
Creates an abstract multilevel numbering with a specified type. |
CreateSection |
Creates a new document section which ends at the specified paragraph. Allows to set local parameters to the current
section - page size, footer, header, columns, etc. |
CreateStyle |
Creates a new style with the specified type and name. If there is a style with the same name it will be replaced with a new one. |
DeleteBookmark |
Removes a bookmark from the document, if one exists. |
GetAllBookmarksNames |
Returns an array with names of all bookmarks in the current document. |
GetAllCaptionParagraphs |
Returns all caption paragraphs of the specified type from the current document. |
GetAllCharts |
Returns a collection of chart objects in the document. |
GetAllContentControls |
Returns a list of all the content controls in the document. |
GetAllDrawingObjects |
Returns a collection of drawing objects in the document. |
GetAllForms |
Returns all existing forms in the document. |
GetAllHeadingParagraphs |
Returns all heading paragraphs from the current document. |
GetAllImages |
Returns a collection of image objects in the document. |
GetAllNumberedParagraphs |
Returns all numbered paragraphs from the current document. |
GetAllShapes |
Returns a collection of shape objects in the document. |
GetAllTablesOnPage |
Returns a collection of tables on a given absolute page.
This method can be a little bit slow, because it runs the document calculation
process to arrange tables on the specified page. |
GetBookmarkRange |
Returns a bookmark range. |
GetClassType |
Returns a type of the ApiDocument class. |
GetCommentsReport |
Returns a report about all the comments added to the document. |
GetDefaultParaPr |
Returns a set of default paragraph properties in the current document. |
GetDefaultStyle |
Returns the default style parameters for the specified document element. |
GetDefaultTextPr |
Returns a set of default properties for the text run in the current document. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
GetEndNotesFirstParagraphs |
Returns the first paragraphs from all endnotes in the current document. |
GetFinalSection |
Returns the document final section. |
GetFootnotesFirstParagraphs |
Returns the first paragraphs from all footnotes in the current document. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified document. |
GetRangeBySelect |
Returns a range object by the current selection. |
GetReviewReport |
Returns a report about every change which was made to the document in the review mode. |
GetSections |
Returns a collection of section objects in the document. |
GetStyle |
Returns a style by its name. |
InsertContent |
Inserts an array of elements into the current position of the document. |
InsertWatermark |
Inserts a watermark on each document page. |
IsTrackRevisions |
Checks if change tracking mode is enabled or not. |
Last |
Returns the last document element. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RejectAllRevisionChanges |
Rejects all changes made in review mode. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
RemoveSelection |
Removes the current selection. |
Search |
Searches for a scope of a document object. The search results are a collection of ApiRange objects. |
SearchAndReplace |
Finds and replaces the text. |
SetEvenAndOddHdrFtr |
Specifies whether sections in this document will have different headers and footers for even and
odd pages (one header/footer for odd pages and another header/footer for even pages). |
SetFormsHighlight |
Sets the highlight to the forms in the document. |
SetTrackRevisions |
Sets the change tracking mode. |
ToHtml |
Converts a document to HTML. |
ToMarkdown |
Converts a document to Markdown. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
GetClassType |
Returns a type of the ApiDocumentContent class. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
GetRange |
Returns a Range object that represents the part of the document contained in the document content. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
Name |
Description |
AddBreak |
Inserts a break at the specified location in the main document. |
Copy |
Copies the current graphic object. |
Delete |
Deletes the current graphic object. |
Fill |
Sets the fill formatting properties to the current graphic object. |
GetClassType |
Returns a type of the ApiDrawing class. |
GetNextDrawing |
Returns the next inline drawing object if exists. |
GetParentContentControl |
Returns a parent content control that contains the graphic object. |
GetParentParagraph |
Returns a parent paragraph that contains the graphic object. |
GetParentTable |
Returns a parent table that contains the graphic object. |
GetParentTableCell |
Returns a parent table cell that contains the graphic object. |
GetPrevDrawing |
Returns the previous inline drawing object if exists. |
InsertInContentControl |
Wraps the graphic object with a rich text content control. |
InsertParagraph |
Inserts a paragraph at the specified position. |
ScaleHeight |
Scales the height of the figure using the specified coefficient. |
ScaleWidth |
Scales the width of the figure using the specified coefficient. |
Select |
Selects the current graphic object. |
SetDistances |
Specifies the minimum distance which will be maintained between the edges of the current drawing object and any
subsequent text. |
SetHorAlign |
Specifies how the floating object will be horizontally aligned. |
SetHorFlip |
Flips the current drawing horizontally. |
SetHorPosition |
Sets the absolute measurement for the horizontal positioning of the floating object. |
SetOutLine |
Sets the outline properties to the specified graphic object. |
SetSize |
Sets the size of the object (image, shape, chart) bounding box. |
SetVerAlign |
Specifies how the floating object will be vertically aligned. |
SetVerPosition |
Sets the absolute measurement for the vertical positioning of the floating object. |
SetVertFlip |
Flips the current drawing vertically. |
SetWrappingStyle |
Sets the wrapping type of the current object (image, shape, chart). One of the following wrapping style types can be set:
- "inline" - the object is considered to be a part of the text, like a character, so when the text moves, the object moves as well. In this case the positioning options are inaccessible.
If one of the following styles is selected, the object can be moved independently of the text and positioned on the page exactly:
- "square" - the text wraps the rectangular box that bounds the object.
- "tight" - the text wraps the actual object edges.
- "through" - the text wraps around the object edges and fills in the open white space within the object.
- "topAndBottom" - the text is only above and below the object.
- "behind" - the text overlaps the object.
- "inFront" - the object overlaps the text.
|
Name |
Description |
GetClassType |
Returns a type of the ApiFill class. |
Name |
Description |
Clear |
Clears the current form. |
GetClassType |
Returns a type of the ApiFormBase class. |
GetFormKey |
Returns the current form key. |
GetFormType |
Returns a type of the current form. |
GetText |
Returns the text from the current form. |
GetTextPr |
Returns the text properties from the current form. |
GetTipText |
Returns the tip text of the current form. |
GetWrapperShape |
Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
The null value will be returned for the inline forms. |
IsFixed |
Checks if the current form is fixed size. |
IsRequired |
Checks if the current form is required. |
SetBackgroundColor |
Sets the background color to the current form. |
SetBorderColor |
Sets the border color to the current form. |
SetFormKey |
Sets a key to the current form. |
SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
SetRequired |
Specifies if the current form should be required. |
SetTextPr |
Sets the text properties to the current form. |
SetTipText |
Sets the tip text to the current form. |
ToFixed |
Converts the current form to a fixed size form. |
ToInline |
Converts the current form to an inline form.
Picture form can't be converted to an inline form, it's always a fixed size object. |
Name |
Description |
GetClassType |
Returns a type of the ApiGradientStop class. |
Name |
Description |
AddElement |
Adds an element to the inline text content control. |
AddText |
Adds text to the current content control. |
Copy |
Creates a copy of an inline content control. Ignores comments, footnote references, complex fields. |
Delete |
Removes a content control and its content. If keepContent is true, the content is not deleted. |
GetAlias |
Returns the alias attribute for the current container. |
GetClassType |
Returns a type of the ApiInlineLvlSdt class. |
GetElement |
Returns an element of the current inline text content control using the position specified. |
GetElementsCount |
Returns a number of elements in the current inline text content control. The text content
control is created with one text run present in it by default, so even without any
element added this method will return the value of '1'. |
GetLabel |
Returns the label attribute for the current container. |
GetLock |
Returns the lock type of the current container. |
GetParentContentControl |
Returns a content control that contains the current content control. |
GetParentParagraph |
Returns a paragraph that contains the current content control. |
GetParentTable |
Returns a table that contains the current content control. |
GetParentTableCell |
Returns a table cell that contains the current content control. |
GetPlaceholderText |
Returns the placeholder text from the current inline content control. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified content control. |
GetTag |
Returns the tag attribute for the current container. |
IsForm |
Checks if the content control is a form. |
Push |
Adds an element to the end of inline text content control. |
RemoveAllElements |
Removes all the elements from the current inline text content control. |
RemoveElement |
Removes an element using the position specified from the current inline text content control. |
SetAlias |
Sets the alias attribute to the current container. |
SetLabel |
Adds a string label to the current inline text content control. |
SetLock |
Sets the lock to the current inline text content control:
"contentLocked" - content cannot be edited.
"sdtContentLocked" - content cannot be edited and the container cannot be deleted.
"sdtLocked" - the container cannot be deleted. |
SetPlaceholderText |
Sets the placeholder text to the current inline content control.
Can't be set to checkbox or radio button |
SetTag |
Adds a string tag to the current inline text content control. |
SetTextPr |
Applies text settings to the content of the content control. |
Name |
Description |
GetClassType |
Returns a type of the ApiNumbering class. |
GetLevel |
Returns the specified level of the current numbering. |
Name |
Description |
GetClassType |
Returns a type of the ApiNumberingLevel class. |
GetLevelIndex |
Returns the level index. |
GetNumbering |
Returns the numbering definition. |
GetParaPr |
Returns the paragraph properties which are applied to any numbered paragraph that references the given numbering definition and numbering level. |
GetTextPr |
Specifies the text properties which will be applied to the text in the current numbering level itself, not to the text in the subsequent paragraph.
To change the text style of the paragraph, a style must be applied to it using the ApiRun.SetStyle method. |
SetCustomType |
Sets your own customized numbering type. |
SetRestart |
Specifies a one-based index which determines when a numbering level should restart to its starting value. A numbering level restarts when an instance of the specified numbering level which is higher (earlier than this level) is used in the given document contents. By default this value is true. |
SetStart |
Specifies the starting value for the numbering used by the parent numbering level within a given numbering level definition. By default this value is 1. |
SetSuff |
Specifies the content which will be added between the given numbering level text and the text of every numbered paragraph which references that numbering level. By default this value is "tab". |
SetTemplateType |
Sets one of the existing predefined numbering templates. |
Name |
Description |
AddBookmarkCrossRef |
Adds a bookmark cross-reference to the current paragraph.
The paragraph must be in the document. |
AddCaptionCrossRef |
Adds a caption cross-reference to the current paragraph.
The paragraph must be in the document. |
AddColumnBreak |
Adds a column break to the current position and starts the next element from a new column. |
AddComment |
Adds a comment to the paragraph. |
AddDrawing |
Adds a drawing object (image, shape or chart) to the current paragraph. |
AddElement |
Adds an element to the current paragraph. |
AddEndnoteCrossRef |
Adds an endnote cross-reference to the current paragraph.
The paragraph must be in the document. |
AddFootnoteCrossRef |
Adds a footnote cross-reference to the current paragraph.
The paragraph must be in the document. |
AddHeadingCrossRef |
Adds a heading cross-reference to the current paragraph.
The paragraph must be in the document. |
AddHyperlink |
Adds a hyperlink to a paragraph. |
AddInlineLvlSdt |
Adds an inline container. |
AddLineBreak |
Adds a line break to the current position and starts the next element from a new line. |
AddNumberedCrossRef |
Adds a numbered cross-reference to the current paragraph.
The paragraph must be in the document. |
AddPageBreak |
Adds a page break and starts the next element from the next page. |
AddPageNumber |
Inserts a number of the current document page into the paragraph.
This method works for the paragraphs in the document header/footer only. |
AddPagesCount |
Inserts a number of pages in the current document into the paragraph.
This method works for the paragraphs in the document header/footer only. |
AddTabStop |
Adds a tab stop to the current paragraph. |
AddText |
Adds some text to the current paragraph. |
Copy |
Creates a paragraph copy. Ingnore comments, footnote references, complex fields. |
Delete |
Deletes the current paragraph. |
GetAllCharts |
Returns a collection of chart objects in the paragraph. |
GetAllContentControls |
Returns a collection of content control objects in the paragraph. |
GetAllDrawingObjects |
Returns a collection of drawing objects in the paragraph. |
GetAllImages |
Returns a collection of image objects in the paragraph. |
GetAllShapes |
Returns a collection of shape objects in the paragraph. |
GetClassType |
Returns a type of the ApiParagraph class. |
GetElement |
Returns a paragraph element using the position specified. |
GetElementsCount |
Returns a number of elements in the current paragraph. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetLastRunWithText |
Returns the last Run with text in the current paragraph. |
GetNext |
Returns the next paragraph. |
GetNumbering |
Returns the numbering definition and numbering level for the numbered list. |
GetParagraphMarkTextPr |
Returns the text properties of the paragraph mark which is used to mark the paragraph end. The mark can also acquire
common text properties like bold, italic, underline, etc. |
GetParaPr |
Returns the paragraph properties. |
GetParentContentControl |
Returns a content control that contains the current paragraph. |
GetParentTable |
Returns a table that contains the current paragraph. |
GetParentTableCell |
Returns a table cell that contains the current paragraph. |
GetPrevious |
Returns the previous paragraph. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified paragraph. |
GetShd |
Returns the shading applied to the contents of the paragraph. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
GetStyle |
Returns the paragraph style method. |
GetText |
Returns the paragraph text. |
GetTextPr |
Returns the paragraph text properties. |
InsertInContentControl |
Wraps the paragraph object with a rich text content control. |
InsertParagraph |
Inserts a paragraph at the specified position. |
Last |
Returns the last element of the paragraph which is not empty. |
Push |
Adds an element to the current paragraph. |
RemoveAllElements |
Removes all the elements from the current paragraph.
When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
RemoveElement |
Removes an element using the position specified.
If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph),
a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
Search |
Searches for a scope of a paragraph object. The search results are a collection of ApiRange objects. |
Select |
Selects the current paragraph. |
SetBetweenBorder |
Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings. |
SetBold |
Sets the bold property to the text character. |
SetBottomBorder |
Specifies the border which will be displayed below a set of paragraphs which have the same paragraph border settings.
The paragraphs of the same style going one by one are considered as a single block, so the border is added
to the whole block rather than to every paragraph in this block. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetCaps |
Specifies that any lowercase characters in this paragraph are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color to the current paragraph in the RGB format. |
SetContextualSpacing |
Specifies that any space before or after this paragraph set using the
ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter spacing element, should not be applied when the preceding and
following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively. |
SetDoubleStrikeout |
Specifies that the contents of this paragraph are displayed with two horizontal lines through each character displayed on the line. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current paragraph. |
SetHighlight |
Specifies a highlighting color which is applied as a background to the contents of the current paragraph. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetItalic |
Sets the italic property to the text character. |
SetJc |
Sets the paragraph contents justification. |
SetKeepLines |
Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible. |
SetKeepNext |
Specifies that when rendering the document using a paginated view, the contents of the current paragraph are at least
partly rendered on the same page as the following paragraph whenever possible. |
SetLeftBorder |
Specifies the border which will be displayed at the left side of the page around the specified paragraph. |
SetNumbering |
Specifies that the current paragraph references the numbering definition instance in the current document. |
SetNumPr |
Specifies that the current paragraph references a numbering definition instance in the current document. |
SetPageBreakBefore |
Specifies that when rendering the document using a paginated view, the contents of the current paragraph are rendered at
the beginning of a new page in the document. |
SetPosition |
Specifies an amount by which text is raised or lowered for this paragraph in relation to the default
baseline of the surrounding non-positioned text. |
SetRightBorder |
Specifies the border which will be displayed at the right side of the page around the specified paragraph. |
SetShd |
Specifies the shading applied to the contents of the current paragraph. |
SetSmallCaps |
Specifies that all the small letter characters in this paragraph are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetStrikeout |
Specifies that the contents of this paragraph are displayed with a single horizontal line through the center of the line. |
SetStyle |
The paragraph style base method.
This method is not used by itself, as it only forms the basis for the ApiParagraph.SetStyle method which sets the selected or created style for the paragraph. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
SetTextPr |
Sets the paragraph text properties. |
SetTopBorder |
Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings.
The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block. |
SetUnderline |
Specifies that the contents of this paragraph are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of this paragraph in relation to the default appearance of the paragraph text:
- "baseline" - the characters in the current paragraph will be aligned by the default text baseline.
- "subscript" - the characters in the current paragraph will be aligned below the default text baseline.
- "superscript" - the characters in the current paragraph will be aligned above the default text baseline.
|
SetWidowControl |
Specifies whether a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page. |
WrapInMailMergeField |
Wraps the paragraph content in a mail merge field. |
Name |
Description |
GetClassType |
Returns a type of the ApiParaPr class. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetShd |
Returns the shading applied to the contents of the paragraph. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
GetStyle |
Returns the paragraph style method. |
SetBetweenBorder |
Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings. |
SetBottomBorder |
Specifies the border which will be displayed below a set of paragraphs which have the same paragraph border settings.
The paragraphs of the same style going one by one are considered as a single block, so the border is added
to the whole block rather than to every paragraph in this block. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetContextualSpacing |
Specifies that any space before or after this paragraph set using the
ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter spacing element, should not be applied when the preceding and
following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetJc |
Sets the paragraph contents justification. |
SetKeepLines |
Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible. |
SetKeepNext |
Specifies that when rendering the document using a paginated view, the contents of the current paragraph are at least
partly rendered on the same page as the following paragraph whenever possible. |
SetLeftBorder |
Specifies the border which will be displayed at the left side of the page around the specified paragraph. |
SetNumPr |
Specifies that the current paragraph references a numbering definition instance in the current document. |
SetPageBreakBefore |
Specifies that when rendering the document using a paginated view, the contents of the current paragraph are rendered at
the beginning of a new page in the document. |
SetRightBorder |
Specifies the border which will be displayed at the right side of the page around the specified paragraph. |
SetShd |
Specifies the shading applied to the contents of the paragraph. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetStyle |
The paragraph style base method.
This method is not used by itself, as it only forms the basis for the ApiParagraph.SetStyle method which sets the selected or created style for the paragraph. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
SetTopBorder |
Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings.
The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block. |
SetWidowControl |
Specifies whether a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page. |
Name |
Description |
Clear |
Clears the current form. |
GetClassType |
Returns a type of the ApiFormBase class. |
GetFormKey |
Returns the current form key. |
GetFormType |
Returns a type of the current form. |
GetImage |
Returns an image in the base64 format from the current picture form. |
GetPicturePosition |
Returns the picture position inside the current form. |
GetScaleFlag |
Returns the current scaling condition of the picture form. |
GetText |
Returns the text from the current form. |
GetTextPr |
Returns the text properties from the current form. |
GetTipText |
Returns the tip text of the current form. |
GetWrapperShape |
Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
The null value will be returned for the inline forms. |
IsFixed |
Checks if the current form is fixed size. |
IsLockAspectRatio |
Checks if the aspect ratio of the current picture form is locked or not. |
IsRequired |
Checks if the current form is required. |
IsRespectBorders |
Checks if the form border width is respected or not. |
SetBackgroundColor |
Sets the background color to the current form. |
SetBorderColor |
Sets the border color to the current form. |
SetFormKey |
Sets a key to the current form. |
SetImage |
Sets an image to the current picture form. |
SetLockAspectRatio |
Locks the aspect ratio of the current picture form. |
SetPicturePosition |
Sets the picture position inside the current form:
- 0 - the picture is placed on the left/top;
- 50 - the picture is placed in the center;
- 100 - the picture is placed on the right/bottom.
|
SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
SetRequired |
Specifies if the current form should be required. |
SetRespectBorders |
Respects the form border width when scaling the image. |
SetScaleFlag |
Sets the scaling condition to the current picture form. |
SetTextPr |
Sets the text properties to the current form. |
SetTipText |
Sets the tip text to the current form. |
ToFixed |
Converts the current form to a fixed size form. |
ToInline |
Converts the current form to an inline form.
Picture form can't be converted to an inline form, it's always a fixed size object. |
Name |
Description |
GetClassType |
Returns a type of the ApiPresetColor class. |
Name |
Description |
AddBookmark |
Adds a bookmark to the specified range. |
AddHyperlink |
Adds a hyperlink to the specified range. |
AddText |
Adds a text to the specified position. |
Delete |
Deletes all the contents from the current range. |
ExpandTo |
Returns a new range that goes beyond the specified range in any direction and spans a different range. The current range has not changed. Throws an error if two ranges do not have a union. |
GetAllParagraphs |
Returns a collection of paragraphs that represents all the paragraphs in the specified range. |
GetClassType |
Returns a type of the ApiRange class. |
GetParagraph |
Returns a paragraph from all the paragraphs that are in the range. |
GetText |
Returns a text from the specified range. |
IntersectWith |
Returns a new range as the intersection of the current range with another range. The current range has not changed. Throws an error if two ranges do not overlap or are not adjacent. |
Select |
Sets the selection to the specified range. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the current text Range are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color to the current text Range in the RGB format. |
SetDoubleStrikeout |
Specifies that the contents of the current Range are displayed with two horizontal lines through each character displayed on the line. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text Range. |
SetHighlight |
Specifies a highlighting color which is applied as a background to the contents of the current Range. |
SetItalic |
Sets the italic property to the text character. |
SetPosition |
Specifies the amount by which text is raised or lowered for the current Range in relation to the default
baseline of the surrounding non-positioned text. |
SetShd |
Specifies the shading applied to the contents of the current text Range. |
SetSmallCaps |
Specifies that all the lowercase letter characters in the current text Range are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the current Range are displayed with a single horizontal line through the range center. |
SetStyle |
Sets the style to the current Range. |
SetTextPr |
Sets the text properties to the current Range. |
SetUnderline |
Specifies that the contents of the current Range are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the Range contents in relation to the default appearance of the Range text:
- "baseline" - the characters in the current text Range will be aligned by the default text baseline.
- "subscript" - the characters in the current text Range will be aligned below the default text baseline.
- "superscript" - the characters in the current text Range will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns a type of the ApiRGBColor class. |
Name |
Description |
AddColumnBreak |
Adds a column break to the current run position and starts the next element from a new column. |
AddDrawing |
Adds a drawing object (image, shape or chart) to the current text run. |
AddHyperlink |
Adds a hyperlink to the current run. |
AddLineBreak |
Adds a line break to the current run position and starts the next element from a new line. |
AddPageBreak |
Adds a page break and starts the next element from a new page. |
AddTabStop |
Adds a tab stop to the current run. |
AddText |
Adds some text to the current run. |
ClearContent |
Clears the content from the current run. |
Copy |
Creates a copy of the current run. |
Delete |
Deletes the current run. |
GetClassType |
Returns a type of the ApiRun class. |
GetNext |
Returns the next run if exists. |
GetParentContentControl |
Returns a content control that contains the current run. |
GetParentTable |
Returns a table that contains the current run. |
GetParentTableCell |
Returns a table cell that contains the current run. |
GetPrevious |
Returns the previous run if exists. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified run. |
GetTextPr |
Returns the text properties of the current run. |
RemoveAllElements |
Removes all the elements from the current run. |
Select |
Selects the current run. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color for the current text run in the RGB format. |
SetDoubleStrikeout |
Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetHighlight |
Specifies a highlighting color which is applied as a background to the contents of the current run. |
SetItalic |
Sets the italic property to the text character. |
SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested) when processing
the contents of this text run. |
SetPosition |
Specifies an amount by which text is raised or lowered for this run in relation to the default
baseline of the surrounding non-positioned text. |
SetShd |
Specifies the shading applied to the contents of the current text run. |
SetSmallCaps |
Specifies that all the small letter characters in this text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. |
SetStyle |
Sets a style to the current run. |
SetTextPr |
Sets the text properties to the current run. |
SetUnderline |
Specifies that the contents of the current run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
WrapInMailMergeField |
Wraps a run in a mail merge field. |
Name |
Description |
GetClassType |
Returns a type of the ApiSchemeColor class. |
Name |
Description |
GetClassType |
Returns a type of the ApiSection class. |
GetFooter |
Returns the content for the specified footer type. |
GetHeader |
Returns the content for the specified header type. |
GetNext |
Returns the next section if exists. |
GetPrevious |
Returns the previous section if exists. |
RemoveFooter |
Removes the footer of the specified type from the current section. After removal, the footer will be inherited from
the previous section, or if this is the first section in the document, no footer of the specified type will be presented. |
RemoveHeader |
Removes the header of the specified type from the current section. After removal, the header will be inherited from
the previous section, or if this is the first section in the document, no header of the specified type will be presented. |
SetEqualColumns |
Specifies that all the text columns in the current section are of equal width. |
SetFooterDistance |
Specifies the distance from the bottom edge of the page to the bottom edge of the footer. |
SetHeaderDistance |
Specifies the distance from the top edge of the page to the top edge of the header. |
SetNotEqualColumns |
Specifies that all the columns in the current section have the different widths. Number of columns is equal
to the length of the aWidth array. The length of the aSpaces array MUST BE equal to (aWidth.length - 1). |
SetPageMargins |
Specifies the page margins for all the pages in this section. |
SetPageSize |
Specifies the properties (size and orientation) for all the pages in the current section. |
SetTitlePage |
Specifies whether the current section in this document has the different header and footer for the section first page. |
SetType |
Specifies a type of the current section. The section type defines how the contents of the current
section are placed relative to the previous section.
WordprocessingML supports five distinct types of section breaks:
- Next page section breaks (the default if type is not specified), which begin the new section on the
following page.
- Odd page section breaks, which begin the new section on the next odd-numbered page.
- Even page section breaks, which begin the new section on the next even-numbered page.
- Continuous section breaks, which begin the new section on the following paragraph. This means that
continuous section breaks might not specify certain page-level section properties, since they shall be
inherited from the following section. These breaks, however, can specify other section properties, such
as line numbering and footnote/endnote settings.
- Column section breaks, which begin the new section on the next column on the page.
|
Name |
Description |
GetClassType |
Returns a type of the ApiShape class. |
GetContent |
Returns the shape inner contents where a paragraph or text runs can be inserted. |
GetDocContent |
Returns the shape inner contents where a paragraph or text runs can be inserted. |
GetNextShape |
Returns the next inline shape if exists. |
GetPrevShape |
Returns the previous inline shape if exists. |
SetPaddings |
Sets the text paddings to the current shape. |
SetVerticalTextAlign |
Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. |
Name |
Description |
GetClassType |
Returns a type of the ApiStroke class. |
Name |
Description |
GetClassType |
Returns a type of the ApiStyle class. |
GetConditionalTableStyle |
Returns a set of formatting properties which will be conditionally applied to the parts of a table that match the
requirement specified in the sType parameter. |
GetName |
Returns a name of the current style. |
GetParaPr |
Returns the paragraph properties of the current style. |
GetTableCellPr |
Returns the table cell properties of the current style. |
GetTablePr |
Returns the table properties of the current style. |
GetTableRowPr |
Returns the table row properties of the current style. |
GetTextPr |
Returns the text properties of the current style. |
GetType |
Returns a type of the current style. |
SetBasedOn |
Specifies the reference to the parent style which this style inherits from in the style hierarchy. |
SetName |
Sets a name of the current style. |
Name |
Description |
AddColumn |
Adds a new column to the current table. |
AddColumns |
Adds the new columns to the current table. |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the cell. |
AddRow |
Adds a new row to the current table. |
AddRows |
Adds the new rows to the current table. |
Clear |
Clears the content from the table. |
Copy |
Creates a copy of the current table. |
Delete |
Deletes the current table. |
GetCell |
Returns a cell by its position. |
GetClassType |
Returns a type of the ApiTable class. |
GetNext |
Returns the next table if exists. |
GetParentContentControl |
Returns a content control that contains the current table. |
GetParentTable |
Returns a table that contains the current table. |
GetParentTableCell |
Returns a table cell that contains the current table. |
GetPrevious |
Returns the previous table if exists. |
GetRange |
Returns a Range object that represents the part of the document contained in the specified table. |
GetRow |
Returns a table row by its position in the table. |
GetRowsCount |
Returns a number of rows in the current table. |
GetTables |
Returns the tables that contain the current table. |
InsertInContentControl |
Wraps the current table object with a content control. |
MergeCells |
Merges an array of cells. If the merge is done successfully, it will return the resulting merged cell, otherwise the result will be "null".
The number of cells in any row and the number of rows in the current table may be changed. |
RemoveColumn |
Removes a table column with a specified cell. |
RemoveRow |
Removes a table row with a specified cell. |
Search |
Searches for a scope of a table object. The search results are a collection of ApiRange objects. |
Select |
Selects the current table. |
SetBackgroundColor |
Sets the background color to all cells in the current table. |
SetCellSpacing |
Specifies the default table cell spacing (the spacing between adjacent cells and the edges of the table). |
SetHAlign |
Sets the horizontal alignment to the table. |
SetJc |
Specifies the alignment of the current table with respect to the text margins in the current section. |
SetPaddings |
Sets the table paddings.
If table is inline, then only left padding is applied. |
SetShd |
Specifies the shading which is applied to the extents of the current table. |
SetStyle |
Sets a style to the current table. |
SetStyleColBandSize |
Specifies a number of columns which will comprise each table column band for this table style. |
SetStyleRowBandSize |
Specifies a number of rows which will comprise each table row band for this table style. |
SetTableBorderBottom |
Sets the border which will be displayed at the bottom of the current table. |
SetTableBorderInsideH |
Specifies the border which will be displayed on all horizontal table cell borders which are not on the outmost edge
of the parent table (all horizontal borders which are not the topmost or bottommost borders). |
SetTableBorderInsideV |
Specifies the border which will be displayed on all vertical table cell borders which are not on the outmost edge
of the parent table (all vertical borders which are not the leftmost or rightmost borders). |
SetTableBorderLeft |
Sets the border which will be displayed on the left of the current table. |
SetTableBorderRight |
Sets the border which will be displayed on the right of the current table. |
SetTableBorderTop |
Sets the border which will be displayed at the top of the current table. |
SetTableCellMarginBottom |
Specifies an amount of space which will be left between the bottom extent of the cell contents and the border
of all table cells within the parent table (or table row). |
SetTableCellMarginLeft |
Specifies an amount of space which will be left between the left extent of the cell contents and the left
border of all table cells within the parent table (or table row). |
SetTableCellMarginRight |
Specifies an amount of space which will be left between the right extent of the cell contents and the right
border of all table cells within the parent table (or table row). |
SetTableCellMarginTop |
Specifies an amount of space which will be left between the top extent of the cell contents and the top border
of all table cells within the parent table (or table row). |
SetTableInd |
Specifies the indentation which will be added before the leading edge of the current table in the document
(the left edge in the left-to-right table, and the right edge in the right-to-left table). |
SetTableLayout |
Specifies the algorithm which will be used to lay out the contents of the current table within the document. |
SetTableLook |
Specifies the conditional formatting components of the referenced table style (if one exists)
which will be applied to the set of table rows with the current table-level property exceptions. A table style
can specify up to six different optional conditional formats, for example, different formatting for the first column,
which then can be applied or omitted from individual table rows in the parent table.
The default setting is to apply the row and column band formatting, but not the first row, last row, first
column, or last column formatting. |
SetTextPr |
Applies the text settings to the entire contents of the table. |
SetVAlign |
Sets the vertical alignment to the table. |
SetWidth |
Sets the preferred width to the current table.
Tables are created with the ApiTable.SetWidth method properties set by default, which always override the ApiTablePr.SetWidth method properties. That is why there is no use to try and apply ApiTablePr.SetWidth . We recommend you to use the ApiTablePr.SetWidth method instead. |
SetWrappingStyle |
Sets the table wrapping style. |
Split |
Splits the cell into a given number of rows and columns. |
Name |
Description |
AddColumns |
Adds the new columns to the current table. |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the cell. |
AddRows |
Adds the new rows to the current table. |
Clear |
Clears the content from the current cell. |
GetClassType |
Returns a type of the ApiTableCell class. |
GetContent |
Returns the current cell content. |
GetIndex |
Returns the current cell index. |
GetNext |
Returns the next cell if exists. |
GetParentRow |
Returns a parent row of the current cell. |
GetParentTable |
Returns a parent table of the current cell. |
GetPrevious |
Returns the previous cell if exists. |
GetRowIndex |
Returns an index of the parent row. |
RemoveColumn |
Removes a column containing the current cell. |
RemoveRow |
Removes a row containing the current cell. |
Search |
Searches for a scope of a table cell object. The search results are a collection of ApiRange objects. |
SetBackgroundColor |
Sets the background color to the current table cell. |
SetCellBorderBottom |
Sets the border which will be displayed at the bottom of the current table cell. |
SetCellBorderLeft |
Sets the border which will be displayed to the left of the current table cell. |
SetCellBorderRight |
Sets the border which will be displayed to the right of the current table cell. |
SetCellBorderTop |
Sets the border which will be displayed at the top of the current table cell. |
SetCellMarginBottom |
Specifies an amount of space which will be left between the bottom extent of the cell contents and the border
of a specific table cell within a table. |
SetCellMarginLeft |
Specifies an amount of space which will be left between the left extent of the cell contents and
the border of a specific table cell within a table. |
SetCellMarginRight |
Specifies an amount of space which will be left between the right extent of the cell contents and the border of a specific table cell within a table. |
SetCellMarginTop |
Specifies an amount of space which will be left between the upper extent of the cell contents
and the border of a specific table cell within a table. |
SetCellPr |
Sets the cell properties to the current cell. |
SetColumnBackgroundColor |
Sets the background color to all cells in the column containing the current cell. |
SetNoWrap |
Specifies how the current table cell is laid out when the parent table is displayed in a document. This setting
only affects the behavior of the cell when the ApiTablePr.SetTableLayout table layout for this table is set to use the "autofit" algorithm. |
SetShd |
Specifies the shading applied to the contents of the table cell. |
SetTextDirection |
Specifies the direction of the text flow for this table cell. |
SetTextPr |
Applies the text settings to the entire contents of the current cell. |
SetVerticalAlign |
Specifies the vertical alignment for the text contents within the current table cell. |
SetWidth |
Sets the preferred width to the current table cell. |
Split |
Splits the cell into a given number of rows and columns. |
Name |
Description |
GetClassType |
Returns a type of the ApiTableCellPr class. |
SetCellBorderBottom |
Sets the border which will be displayed at the bottom of the current table cell. |
SetCellBorderLeft |
Sets the border which will be displayed to the left of the current table cell. |
SetCellBorderRight |
Sets the border which will be displayed to the right of the current table cell. |
SetCellBorderTop |
Sets the border which will be displayed at the top of the current table cell. |
SetCellMarginBottom |
Specifies an amount of space which will be left between the bottom extent of the cell contents and the border
of a specific table cell within a table. |
SetCellMarginLeft |
Specifies an amount of space which will be left between the left extent of the cell contents and
the border of a specific table cell within a table. |
SetCellMarginRight |
Specifies an amount of space which will be left between the right extent of the cell contents and the border of a specific table cell within a table. |
SetCellMarginTop |
Specifies an amount of space which will be left between the upper extent of the cell contents
and the border of a specific table cell within a table. |
SetNoWrap |
Specifies how the current table cell is laid out when the parent table is displayed in a document. This setting
only affects the behavior of the cell when the ApiTablePr.SetTableLayout table layout for this table is set to use the "autofit" algorithm. |
SetShd |
Specifies the shading applied to the contents of the table cell. |
SetTextDirection |
Specifies the direction of the text flow for this table cell. |
SetVerticalAlign |
Specifies the vertical alignment for the text contents within the current table cell. |
SetWidth |
Sets the preferred width to the current table cell. |
Name |
Description |
GetClassType |
Returns a type of the ApiTablePr class. |
SetCellSpacing |
Specifies the default table cell spacing (the spacing between adjacent cells and the edges of the table). |
SetJc |
Specifies the alignment of the current table with respect to the text margins in the current section. |
SetShd |
Specifies the shading which is applied to the extents of the current table. |
SetStyleColBandSize |
Specifies a number of columns which will comprise each table column band for this table style. |
SetStyleRowBandSize |
Specifies a number of rows which will comprise each table row band for this table style. |
SetTableBorderBottom |
Sets the border which will be displayed at the bottom of the current table. |
SetTableBorderInsideH |
Specifies the border which will be displayed on all horizontal table cell borders which are not on the outmost edge
of the parent table (all horizontal borders which are not the topmost or bottommost borders). |
SetTableBorderInsideV |
Specifies the border which will be displayed on all vertical table cell borders which are not on the outmost edge
of the parent table (all vertical borders which are not the leftmost or rightmost borders). |
SetTableBorderLeft |
Sets the border which will be displayed on the left of the current table. |
SetTableBorderRight |
Sets the border which will be displayed on the right of the current table. |
SetTableBorderTop |
Sets the border which will be displayed at the top of the current table. |
SetTableCellMarginBottom |
Specifies an amount of space which will be left between the bottom extent of the cell contents and the border
of all table cells within the parent table (or table row). |
SetTableCellMarginLeft |
Specifies an amount of space which will be left between the left extent of the cell contents and the left
border of all table cells within the parent table (or table row). |
SetTableCellMarginRight |
Specifies an amount of space which will be left between the right extent of the cell contents and the right
border of all table cells within the parent table (or table row). |
SetTableCellMarginTop |
Specifies an amount of space which will be left between the top extent of the cell contents and the top border
of all table cells within the parent table (or table row). |
SetTableInd |
Specifies the indentation which will be added before the leading edge of the current table in the document
(the left edge in the left-to-right table, and the right edge in the right-to-left table). |
SetTableLayout |
Specifies the algorithm which will be used to lay out the contents of the current table within the document. |
SetWidth |
Sets the preferred width to the current table.
Tables are created with the ApiTable.SetWidth method properties set by default, which always override the ApiTablePr.SetWidth method properties. That is why there is no use to try and apply ApiTablePr.SetWidth . We recommend you to use the ApiTablePr.SetWidth method instead. |
Name |
Description |
AddRows |
Adds the new rows to the current table. |
Clear |
Clears the content from the current row. |
GetCell |
Returns a cell by its position. |
GetCellsCount |
Returns a number of cells in the current row. |
GetClassType |
Returns a type of the ApiTableRow class. |
GetIndex |
Returns the current row index. |
GetNext |
Returns the next row if exists. |
GetParentTable |
Returns the parent table of the current row. |
GetPrevious |
Returns the previous row if exists. |
MergeCells |
Merges the cells in the current row. |
Remove |
Removes the current table row. |
Search |
Searches for a scope of a table row object. The search results are a collection of ApiRange objects. |
SetBackgroundColor |
Sets the background color to all cells in the current table row. |
SetHeight |
Sets the height to the current table row within the current table. |
SetTableHeader |
Specifies that the current table row will be repeated at the top of each new page
wherever this table is displayed. This gives this table row the behavior of a 'header' row on
each of these pages. This element can be applied to any number of rows at the top of the
table structure in order to generate multi-row table headers. |
SetTextPr |
Sets the text properties to the current row. |
Name |
Description |
GetClassType |
Returns a type of the ApiTableRowPr class. |
SetHeight |
Sets the height to the current table row within the current table. |
SetTableHeader |
Specifies that the current table row will be repeated at the top of each new page
wherever this table is displayed. This gives this table row the behavior of a 'header' row on
each of these pages. This element can be applied to any number of rows at the top of the
table structure in order to generate multi-row table headers. |
Name |
Description |
GetClassType |
Returns a type of the ApiTableStylePr class. |
GetParaPr |
Returns a set of the paragraph properties which will be applied to all the paragraphs within a table which match the conditional formatting type. |
GetTableCellPr |
Returns a set of the table cell properties which will be applied to all the cells within a table which match the conditional formatting type. |
GetTablePr |
Returns a set of the table properties which will be applied to all the regions within a table which match the conditional formatting type. |
GetTableRowPr |
Returns a set of the table row properties which will be applied to all the rows within a table which match the conditional formatting type. |
GetTextPr |
Returns a set of the text run properties which will be applied to all the text runs within the table which match the conditional formatting type. |
GetType |
Returns a type of the current table conditional style. |
Name |
Description |
Clear |
Clears the current form. |
GetCharactersLimit |
Returns a limit of the text form characters. |
GetClassType |
Returns a type of the ApiFormBase class. |
GetFormKey |
Returns the current form key. |
GetFormType |
Returns a type of the current form. |
GetText |
Returns the text from the current form. |
GetTextPr |
Returns the text properties from the current form. |
GetTipText |
Returns the tip text of the current form. |
GetWrapperShape |
Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
The null value will be returned for the inline forms. |
IsAutoFit |
Checks if the text form content is autofit, i.e. whether the font size adjusts to the size of the fixed size form. |
IsComb |
Checks if the text form is a comb of characters with the same cell width. |
IsFixed |
Checks if the current form is fixed size. |
IsMultiline |
Checks if the current text form is multiline. |
IsRequired |
Checks if the current form is required. |
SetAutoFit |
Specifies if the text form content should be autofit, i.e. whether the font size adjusts to the size of the fixed size form. |
SetBackgroundColor |
Sets the background color to the current form. |
SetBorderColor |
Sets the border color to the current form. |
SetCellWidth |
Sets the cell width to the applied comb of characters. |
SetCharactersLimit |
Sets a limit to the text form characters. |
SetComb |
Specifies if the text form should be a comb of characters with the same cell width.
The maximum number of characters must be set to a positive value. |
SetFormKey |
Sets a key to the current form. |
SetMultiline |
Specifies if the current text form should be miltiline. |
SetPlaceholderText |
Sets the placeholder text to the current form.
Can't be set to checkbox or radio button. |
SetRequired |
Specifies if the current form should be required. |
SetText |
Sets the text to the current text form. |
SetTextPr |
Sets the text properties to the current form. |
SetTipText |
Sets the tip text to the current form. |
ToFixed |
Converts the current form to a fixed size form. |
ToInline |
Converts the current form to an inline form.
Picture form can't be converted to an inline form, it's always a fixed size object. |
Name |
Description |
GetClassType |
Returns a type of the ApiTextPr class. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color to the current text run in the RGB format. |
SetDoubleStrikeout |
Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetHighlight |
Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph. |
SetItalic |
Sets the italic property to the text character. |
SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested) when processing
the contents of the text run. |
SetPosition |
Specifies an amount by which text is raised or lowered for this run in relation to the default
baseline of the surrounding non-positioned text. |
SetShd |
Specifies the shading applied to the contents of the current text run. |
SetSmallCaps |
Specifies that all the small letter characters in the text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. |
SetStyle |
The text style base method.
This method is not used by itself, as it only forms the basis for the ApiRun.SetStyle method which sets
the selected or created style to the text. |
SetUnderline |
Specifies that the contents of the run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns a type of the ApiUniColor class. |
Name |
Description |
GetClassType |
Returns a type of the ApiUnsupported class. |
Name |
Description |
AddDefName |
Adds a new name to a range of cells. |
AddSheet |
Creates a new worksheet. The new worksheet becomes the active sheet. |
CreateBlipFill |
Creates a blip fill to apply to the object using the selected image as the object background. |
CreateBullet |
Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter. |
CreateColorByName |
Creates a color selecting it from one of the available color presets. |
CreateColorFromRGB |
Creates an RGB color setting the appropriate values for the red, green and blue color components. |
CreateGradientStop |
Creates a gradient stop used for different types of gradients. |
CreateLinearGradientFill |
Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. |
CreateNewHistoryPoint |
Creates a new history point. |
CreateNoFill |
Creates no fill and removes the fill from the element. |
CreateNumbering |
Creates a bullet for a paragraph with the numbering character or symbol specified with the sType parameter. |
CreateParagraph |
Creates a new paragraph. |
CreatePatternFill |
Creates a pattern fill to apply to the object using the selected pattern as the object background. |
CreatePresetColor |
Creates a color selecting it from one of the available color presets. |
CreateRadialGradientFill |
Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. |
CreateRGBColor |
Creates an RGB color setting the appropriate values for the red, green and blue color components. |
CreateRun |
Creates a new smaller text block to be inserted to the current paragraph or table. |
CreateSchemeColor |
Creates a complex color scheme selecting from one of the available schemes. |
CreateSolidFill |
Creates a solid fill to apply to the object using a selected solid color as the object background. |
CreateStroke |
Creates a stroke adding shadows to the element. |
Format |
Returns a class formatted according to the instructions contained in the format expression. |
GetActiveSheet |
Returns an object that represents the active sheet. |
GetDefName |
Returns the ApiName object by the range name. |
GetLocale |
Returns the current locale ID. |
GetMailMergeData |
Returns the mail merge data. |
GetRange |
Returns the ApiRange object by the range reference. |
GetSelection |
Returns an object that represents the selected range. |
GetSheet |
Returns an object that represents a sheet. |
GetSheets |
Returns a sheet collection that represents all the sheets in the active workbook. |
GetThemesColors |
Returns a list of all the available theme colors for the spreadsheet. |
Intersect |
Returns the ApiRange object that represents the rectangular intersection of two or more ranges. If one or more ranges from a different worksheet are specified, an error will be returned. |
RecalculateAllFormulas |
Recalculates all formulas in the active workbook. |
ReplaceTextSmart |
Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. |
Save |
Saves changes to the specified document. |
SetLocale |
Sets a locale to the document. |
SetThemeColors |
Sets the theme colors to the current spreadsheet. |
Name |
Description |
GetCount |
Returns a value that represents the number of objects in the collection. |
GetItem |
Returns a single object from a collection by its ID. |
GetParent |
Returns the parent object for the specified collection. |
Name |
Description |
GetClassType |
Returns a type of the ApiBullet class. |
Name |
Description |
GetClassType |
Returns a type of the ApiColor class. |
Name |
Description |
Delete |
Deletes the ApiComment object. |
GetClassType |
Returns a type of the ApiComment class. |
GetText |
Returns the comment text. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
GetClassType |
Returns a type of the ApiDocumentContent class. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
Name |
Description |
GetClassType |
Returns a type of the ApiDrawing class. |
SetPosition |
Changes the position for the drawing object.
Please note that the horizontal and vertical offsets are calculated within the limits of
the specified column and row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. |
SetSize |
Sets a size of the object (image, shape, chart) bounding box. |
Name |
Description |
GetClassType |
Returns a type of the ApiFill class. |
Name |
Description |
GetClassType |
Returns a type of the ApiGradientStop class. |
Name |
Description |
GetClassType |
Returns a type of the ApiImage class. |
Name |
Description |
Delete |
Deletes the DefName object. |
GetName |
Returns a type of the ApiName class. |
GetRefersTo |
Returns a formula that the name is defined to refer to. |
GetRefersToRange |
Returns the ApiRange object by its name. |
SetName |
Sets a string value representing the object name. |
SetRefersTo |
Sets a formula that the name is defined to refer to. |
Name |
Description |
AddElement |
Adds an element to the current paragraph. |
AddLineBreak |
Adds a line break to the current position and starts the next element from a new line. |
AddTabStop |
Adds a tab stop to the current paragraph. |
AddText |
Adds some text to the current paragraph. |
Copy |
Creates a paragraph copy. Ingnore comments, footnote references, complex fields. |
Delete |
Deletes the current paragraph. |
GetClassType |
Returns a type of the ApiParagraph class. |
GetElement |
Returns a paragraph element using the position specified. |
GetElementsCount |
Returns a number of elements in the current paragraph. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetNext |
Returns the next paragraph. |
GetParaPr |
Returns the paragraph properties. |
GetPrevious |
Returns the previous paragraph. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
RemoveAllElements |
Removes all the elements from the current paragraph.
When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
RemoveElement |
Removes an element using the position specified.
If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph),
a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetJc |
Sets the paragraph contents justification. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
Name |
Description |
GetClassType |
Returns a type of the ApiParaPr class. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetJc |
Sets the paragraph contents justification. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
Name |
Description |
GetClassType |
Returns a type of the ApiPresetColor class. |
Name |
Description |
AddComment |
Adds a comment to the current range. |
AutoFit |
Changes the width of the columns or the height of the rows in the range to achieve the best fit. |
Clear |
Clears the current range. |
Copy |
Copies a range to the specified range. |
Delete |
Deletes the Range object. |
End |
Returns a Range object that represents the end in the specified direction in the specified range. |
ForEach |
Executes a provided function once for each cell. |
GetAddress |
Returns the cell address. |
GetAreas |
Returns a collection of the ranges. |
GetCells |
Returns a Range object that represents all the cells in the specified range or a specified cell. |
GetClassType |
Returns a type of the ApiRange class. |
GetCol |
Returns a column number for the selected cell. |
GetCols |
Returns a Range object that represents the columns in the specified range. |
GetColumnWidth |
Returns the column width value. |
GetComment |
Returns the ApiComment object of the current range. |
GetCount |
Returns the rows or columns count. |
GetDefName |
Returns the ApiName object of the current range. |
GetFillColor |
Returns the background color for the current cell range. Returns 'No Fill' when the color of the background in the cell / cell range is null. |
GetFormula |
Returns a formula of the first cell in the current range. |
GetHidden |
Returns the value hiding property. |
GetOrientation |
Returns the current range angle. |
GetRow |
Returns a row number for the selected cell. |
GetRowHeight |
Returns the row height value. |
GetRows |
Returns a Range object that represents the rows in the specified range. If the specified row is outside the Range object, a new Range will be returned that represents the cells between the columns of the original range in the specified row. |
GetText |
Returns the text of the first cell in the current range. |
GetValue |
Returns a value of the first cell in the current range. |
GetValue2 |
Returns the Value2 property (value without format) of the first cell in the current range. |
GetWorksheet |
Returns the Worksheet object that represents the worksheet containing the specified range. It will be available in the read-only mode. |
GetWrapText |
Returns the information about the wrapping cell style. |
Insert |
Inserts a cell or a range of cells into the worksheet or macro sheet and shifts other cells away to make space. |
Merge |
Merges the selected cell range into a single cell or a cell row. |
Paste |
Pastes the Range object to the specified range. |
Select |
Selects the current range. |
SetAlignHorizontal |
Sets the horizontal alignment of the text in the current cell range. |
SetAlignVertical |
Sets the vertical alignment of the text in the current cell range. |
SetBold |
Sets the bold property to the text characters in the current cell or cell range. |
SetBorders |
Sets the border to the cell / cell range with the parameters specified. |
SetColumnWidth |
Sets the width of all the columns in the current range.
One unit of column width is equal to the width of one character in the Normal style.
For proportional fonts, the width of the character 0 (zero) is used. |
SetFillColor |
Sets the background color to the current cell range with the previously created color object.
Sets 'No Fill' when previously created color object is null. |
SetFontColor |
Sets the text color to the current cell range with the previously created color object. |
SetFontName |
Sets the specified font family as the font name for the current cell range. |
SetFontSize |
Sets the font size to the characters of the current cell range. |
SetHidden |
Sets the value hiding property. |
SetItalic |
Sets the italic property to the text characters in the current cell or cell range. |
SetNumberFormat |
Specifies whether a number in the cell should be treated like number, currency, date, time, etc. or just like text. |
SetOffset |
Sets the cell offset. |
SetOrientation |
Sets an angle to the current cell range. |
SetRowHeight |
Sets the row height value. |
SetSort |
Sorts the cells in the given range by the parameters specified in the request. |
SetStrikeout |
Specifies that the contents of the cell / cell range are displayed with a single horizontal line through the center of the contents. |
SetUnderline |
Specifies that the contents of the current cell / cell range are displayed along with a line appearing directly below the character. |
SetValue |
Sets a value to the current cell or cell range. |
SetWrap |
Specifies whether the words in the cell must be wrapped to fit the cell size or not. |
UnMerge |
Splits the selected merged cell range into the single cells. |
Name |
Description |
GetClassType |
Returns a type of the ApiRGBColor class. |
Name |
Description |
AddLineBreak |
Adds a line break to the current run position and starts the next element from a new line. |
AddTabStop |
Adds a tab stop to the current run. |
AddText |
Adds some text to the current run. |
ClearContent |
Clears the content from the current run. |
Copy |
Creates a copy of the current run. |
Delete |
Deletes the current run. |
GetClassType |
Returns a type of the ApiRun class. |
GetTextPr |
Returns the text properties of the current run. |
RemoveAllElements |
Removes all the elements from the current run. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color for the current text run in the RGB format. |
SetDoubleStrikeout |
Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetHighlight |
Specifies a highlighting color which is applied as a background to the contents of the current run. |
SetItalic |
Sets the italic property to the text character. |
SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested) when processing
the contents of this text run. |
SetPosition |
Specifies an amount by which text is raised or lowered for this run in relation to the default
baseline of the surrounding non-positioned text. |
SetShd |
Specifies the shading applied to the contents of the current text run. |
SetSmallCaps |
Specifies that all the small letter characters in this text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. |
SetStyle |
Sets a style to the current run. |
SetTextPr |
Sets the text properties to the current run. |
SetUnderline |
Specifies that the contents of the current run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns a type of the ApiSchemeColor class. |
Name |
Description |
GetClassType |
Returns a type of the ApiShape class. |
GetContent |
Returns the shape inner contents where a paragraph or text runs can be inserted. |
GetDocContent |
Returns the shape inner contents where a paragraph or text runs can be inserted. |
SetPaddings |
Sets the text paddings to the current shape. |
SetVerticalTextAlign |
Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. |
Name |
Description |
GetClassType |
Returns a type of the ApiStroke class. |
Name |
Description |
GetClassType |
Returns a type of the ApiTextPr class. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. |
SetDoubleStrikeout |
Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetItalic |
Sets the italic property to the text character. |
SetSmallCaps |
Specifies that all the small letter characters in the text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. |
SetUnderline |
Specifies that the contents of the run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns a type of the ApiUniColor class. |
Name |
Description |
AddChart |
Creates a chart of the specified type from the selected data range of the current sheet.
Please note that the horizontal and vertical offsets are calculated within the limits of the specified column and
row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. |
AddDefName |
Adds a new name to the current worksheet. |
AddImage |
Adds an image to the current sheet with the parameters specified. |
AddShape |
Adds a shape to the current sheet with the parameters specified.
Please note that the horizontal and vertical offsets are
calculated within the limits of the specified column and row cells
only. If this value exceeds the cell width or height, another vertical/horizontal position will be set. |
Delete |
Deletes the current worksheet. |
FormatAsTable |
Formats the selected range of cells from the current sheet as a table (with the first row formatted as a header).
As the first row is always formatted as a table header, you need to select at least two rows for the table to be formed correctly. |
GetActiveCell |
Returns an object that represents an active cell. |
GetBottomMargin |
Returns the bottom margin of the sheet. |
GetCells |
Returns the ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use). |
GetCols |
Returns the ApiRange object that represents all the cells on the columns range. |
GetComments |
Returns an array of ApiComment objects. |
GetDefName |
Returns the ApiName object by the worksheet name. |
GetDefNames |
Returns an array of ApiName objects. |
GetIndex |
Returns a sheet index. |
GetLeftMargin |
Returns the left margin of the sheet. |
GetName |
Returns a sheet name. |
GetPageOrientation |
Returns the page orientation. |
GetPrintGridlines |
Returns the page PrintGridlines property which specifies whether the current sheet gridlines must be printed or not. |
GetPrintHeadings |
Returns the page PrintHeadings property which specifies whether the current sheet row/column headings must be printed or not. |
GetRange |
Returns an object that represents the selected range of the current sheet. Can be a single cell - A1, or cells
from a single row - A1:E1, or cells from a single column - A1:A10, or cells from several rows and columns - A1:E10. |
GetRangeByNumber |
Returns an object that represents the selected range of the current sheet using the row/column coordinates for the cell selection. |
GetRightMargin |
Returns the right margin of the sheet. |
GetRows |
Returns the ApiRange object that represents all the cells on the rows range. |
GetSelection |
Returns an object that represents the selected range. |
GetTopMargin |
Returns the top margin of the sheet. |
GetUsedRange |
Returns the ApiRange object that represents the used range on the specified worksheet. |
GetVisible |
Returns the state of sheet visibility. |
ReplaceCurrentImage |
Replaces the current image with a new one. |
SetActive |
Makes the current sheet active. |
SetBottomMargin |
Sets the bottom margin of the sheet. |
SetColumnWidth |
Sets the width of the specified column.
One unit of column width is equal to the width of one character in the Normal style.
For proportional fonts, the width of the character 0 (zero) is used. |
SetDisplayGridlines |
Specifies whether the current sheet gridlines must be displayed or not. |
SetDisplayHeadings |
Specifies whether the current sheet row/column headers must be displayed or not. |
SetHyperlink |
Adds a hyperlink to the specified range. |
SetLeftMargin |
Sets the left margin of the sheet. |
SetName |
Sets a name to the current active sheet. |
SetPageOrientation |
Sets the page orientation. |
SetPrintGridlines |
Specifies whether the current sheet gridlines must be printed or not. |
SetPrintHeadings |
Specifies whether the current sheet row/column headers must be printed or not. |
SetRightMargin |
Sets the right margin of the sheet. |
SetRowHeight |
Sets the height of the specified row measured in points.
A point is 1/72 inch. |
SetTopMargin |
Sets the top margin of the sheet. |
SetVisible |
Sets the state of sheet visibility. |
Name |
Description |
CreateBlipFill |
Creates a blip fill to apply to the object using the selected image as the object background. |
CreateBullet |
Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter. |
CreateChart |
Creates a chart with the parameters specified. |
CreateGradientStop |
Creates a gradient stop used for different types of gradients. |
CreateGroup |
Creates a group of drawings. |
CreateImage |
Creates an image with the parameters specified. |
CreateLayout |
Creates a new slide layout and adds it to the slide master if it is specified. |
CreateLinearGradientFill |
Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background. |
CreateMaster |
Creates a new slide master. |
CreateNoFill |
Creates no fill and removes the fill from the element. |
CreateNumbering |
Creates a bullet for a paragraph with the numbering character or symbol specified with the sType parameter. |
CreateParagraph |
Creates a new paragraph. |
CreatePatternFill |
Creates a pattern fill to apply to the object using the selected pattern as the object background. |
CreatePlaceholder |
Creates a new placeholder. |
CreatePresetColor |
Creates a color selecting it from one of the available color presets. |
CreateRadialGradientFill |
Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background. |
CreateRGBColor |
Creates an RGB color setting the appropriate values for the red, green and blue color components. |
CreateRun |
Creates a new smaller text block to be inserted to the current paragraph or table. |
CreateSchemeColor |
Creates a complex color scheme selecting from one of the available schemes. |
CreateShape |
Creates a shape with the parameters specified. |
CreateSlide |
Creates a new slide. |
CreateSolidFill |
Creates a solid fill to apply to the object using a selected solid color as the object background. |
CreateStroke |
Creates a stroke adding shadows to the element. |
CreateTable |
Creates a table. |
CreateTheme |
Creates a new presentation theme. |
CreateThemeColorScheme |
Creates a new theme color scheme. |
CreateThemeFontScheme |
Creates a new theme font scheme. |
CreateThemeFormatScheme |
Creates a new theme format scheme. |
GetPresentation |
Returns the main presentation. |
ReplaceTextSmart |
Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. |
Save |
Saves changes to the specified document. |
Name |
Description |
GetClassType |
Returns a type of the ApiBullet class. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
Name |
Description |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the document content. |
GetClassType |
Returns a type of the ApiDocumentContent class. |
GetElement |
Returns an element by its position in the document. |
GetElementsCount |
Returns a number of elements in the current document. |
Push |
Pushes a paragraph or a table to actually add it to the document. |
RemoveAllElements |
Removes all the elements from the current document or from the current document element.
When all elements are removed, a new empty paragraph is automatically created. If you want to add
content to this paragraph, use the ApiDocumentContent.GetElement method. |
RemoveElement |
Removes an element using the position specified. |
Name |
Description |
Copy |
Creates a copy of the specified drawing object. |
Delete |
Deletes the specified drawing object from the parent. |
GetClassType |
Returns the type of the ApiDrawing class. |
GetParent |
Returns the drawing parent object. |
GetParentLayout |
Returns the drawing parent slide layout. |
GetParentMaster |
Returns the drawing parent slide master. |
GetParentSlide |
Returns the drawing parent slide. |
GetPlaceholder |
Returns a placeholder from the current drawing object. |
SetPlaceholder |
Sets the specified placeholder to the current drawing object. |
SetPosition |
Sets the position of the drawing on the slide. |
SetSize |
Sets the size of the object (image, shape, chart) bounding box. |
Name |
Description |
GetClassType |
Returns a type of the ApiFill class. |
Name |
Description |
GetClassType |
Returns a type of the ApiGradientStop class. |
Name |
Description |
GetClassType |
Returns the type of the ApiImage class. |
Name |
Description |
AddObject |
Adds an object (image, shape or chart) to the current slide layout. |
ClearBackground |
Clears the slide layout background. |
Copy |
Creates a copy of the specified slide layout object. |
Delete |
Deletes the specified object from the parent slide master if it exists. |
Duplicate |
Creates a duplicate of the specified slide layout object, adds the new slide layout to the slide layout collection. |
FollowMasterBackground |
Sets the master background as the background of the layout. |
GetAllCharts |
Returns an array with all the chart objects from the slide layout. |
GetAllDrawings |
Returns an array with all the drawing objects from the slide layout. |
GetAllImages |
Returns an array with all the image objects from the slide layout. |
GetAllShapes |
Returns an array with all the shape objects from the slide layout. |
GetClassType |
Returns the type of the ApiLayout class. |
GetMaster |
Returns the parent slide master of the current layout. |
MoveTo |
Moves the specified layout to a specific location within the same collection. |
RemoveObject |
Removes objects (image, shape or chart) from the current slide layout. |
SetBackground |
Sets the background to the current slide layout. |
SetName |
Sets a name to the current layout. |
Name |
Description |
AddLayout |
Adds a layout to the specified slide master. |
AddObject |
Adds an object (image, shape or chart) to the current slide master. |
ClearBackground |
Clears the slide master background. |
Copy |
Creates a copy of the specified slide master object. |
Delete |
Deletes the specified object from the parent if it exists. |
Duplicate |
Creates a duplicate of the specified slide master object, adds the new slide master to the slide masters collection. |
GetAllCharts |
Returns an array with all the chart objects from the slide master. |
GetAllDrawings |
Returns an array with all the drawing objects from the slide master. |
GetAllImages |
Returns an array with all the image objects from the slide master. |
GetAllShapes |
Returns an array with all the shape objects from the slide master. |
GetClassType |
Returns the type of the ApiMaster class. |
GetLayout |
Returns a layout of the specified slide master by its position. |
GetLayoutsCount |
Returns a number of layout objects. |
GetTheme |
Returns a theme of the slide master. |
RemoveLayout |
Removes the layouts from the current slide master. |
RemoveObject |
Removes objects (image, shape or chart) from the current slide master. |
SetBackground |
Sets the background to the current slide master. |
SetTheme |
Sets a theme to the slide master.
Sets a copy of the theme object. |
Name |
Description |
AddElement |
Adds an element to the current paragraph. |
AddLineBreak |
Adds a line break to the current position and starts the next element from a new line. |
AddTabStop |
Adds a tab stop to the current paragraph. |
AddText |
Adds some text to the current paragraph. |
Copy |
Creates a paragraph copy. Ingnore comments, footnote references, complex fields. |
Delete |
Deletes the current paragraph. |
GetClassType |
Returns a type of the ApiParagraph class. |
GetElement |
Returns a paragraph element using the position specified. |
GetElementsCount |
Returns a number of elements in the current paragraph. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetNext |
Returns the next paragraph. |
GetParaPr |
Returns the paragraph properties. |
GetPrevious |
Returns the previous paragraph. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
RemoveAllElements |
Removes all the elements from the current paragraph.
When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
RemoveElement |
Removes an element using the position specified.
If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph),
a new empty run is automatically created. If you want to add
content to this run, use the ApiParagraph.GetElement method. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetJc |
Sets the paragraph contents justification. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
Name |
Description |
GetClassType |
Returns a type of the ApiParaPr class. |
GetIndFirstLine |
Returns the paragraph first line indentation. |
GetIndLeft |
Returns the paragraph left side indentation. |
GetIndRight |
Returns the paragraph right side indentation. |
GetJc |
Returns the paragraph contents justification. |
GetSpacingAfter |
Returns the spacing after value of the current paragraph. |
GetSpacingBefore |
Returns the spacing before value of the current paragraph. |
GetSpacingLineRule |
Returns the paragraph line spacing rule. |
GetSpacingLineValue |
Returns the paragraph line spacing value. |
SetBullet |
Sets the bullet or numbering to the current paragraph. |
SetIndFirstLine |
Sets the paragraph first line indentation. |
SetIndLeft |
Sets the paragraph left side indentation. |
SetIndRight |
Sets the paragraph right side indentation. |
SetJc |
Sets the paragraph contents justification. |
SetSpacingAfter |
Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then
any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it
will be interpreted as false. |
SetSpacingBefore |
Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then
any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then
it will be interpreted as false. |
SetSpacingLine |
Sets the paragraph line spacing. If the value of the sLineRule parameter is either
"atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If
the value of the sLineRule parameter is "auto", then the value of the
nLine parameter will be interpreted as 240ths of a line. |
SetTabs |
Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
Warning: The lengths of aPos array and aVal array MUST BE equal to each other. |
Name |
Description |
GetClassType |
Returns the type of the ApiPlaceholder class. |
SetType |
Sets the placeholder type. |
Name |
Description |
AddMaster |
Adds the slide master to the presentation slide masters collection. |
AddSlide |
Appends a new slide to the end of the presentation. |
ApplyTheme |
Applies a theme to all the slides in the presentation. |
CreateNewHistoryPoint |
Creates a new history point. |
GetClassType |
Returns a type of the ApiPresentation class. |
GetCurrentSlide |
Returns the current slide. |
GetCurSlideIndex |
Returns the index for the current slide. |
GetMaster |
Returns a slide master by its position in the presentation. |
GetMastersCount |
Returns a number of slide masters. |
GetSlideByIndex |
Returns a slide by its position in the presentation. |
GetSlidesCount |
Returns a number of slides. |
RemoveSlides |
Removes a range of slides from the presentation.
Deletes all the slides from the presentation if no parameters are specified. |
ReplaceCurrentImage |
Replaces the current image with an image specified. |
SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested). |
SetSizes |
Sets the size to the current presentation. |
Name |
Description |
GetClassType |
Returns a type of the ApiPresetColor class. |
Name |
Description |
GetClassType |
Returns a type of the ApiRGBColor class. |
Name |
Description |
AddLineBreak |
Adds a line break to the current run position and starts the next element from a new line. |
AddTabStop |
Adds a tab stop to the current run. |
AddText |
Adds some text to the current run. |
ClearContent |
Clears the content from the current run. |
Copy |
Creates a copy of the current run. |
Delete |
Deletes the current run. |
GetClassType |
Returns a type of the ApiRun class. |
GetTextPr |
Returns the text properties of the current run. |
RemoveAllElements |
Removes all the elements from the current run. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the current text run are formatted for display only as their capital letter character equivalents. |
SetColor |
Sets the text color for the current text run in the RGB format. |
SetDoubleStrikeout |
Specifies that the contents of the current run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetHighlight |
Specifies a highlighting color which is applied as a background to the contents of the current run. |
SetItalic |
Sets the italic property to the text character. |
SetLanguage |
Specifies the languages which will be used to check spelling and grammar (if requested) when processing
the contents of this text run. |
SetPosition |
Specifies an amount by which text is raised or lowered for this run in relation to the default
baseline of the surrounding non-positioned text. |
SetShd |
Specifies the shading applied to the contents of the current text run. |
SetSmallCaps |
Specifies that all the small letter characters in this text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the current run are displayed with a single horizontal line through the center of the line. |
SetStyle |
Sets a style to the current run. |
SetTextPr |
Sets the text properties to the current run. |
SetUnderline |
Specifies that the contents of the current run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the current run in relation to the default appearance of the text run:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns a type of the ApiSchemeColor class. |
Name |
Description |
GetClassType |
Returns the type of the ApiShape class. |
GetContent |
Returns the shape inner contents where a paragraph or text runs can be inserted. |
GetDocContent |
Deprecated in 6.2.
Returns the shape inner contents where a paragraph or text runs can be inserted. |
SetVerticalTextAlign |
Sets the vertical alignment to the shape content where a paragraph or text runs can be inserted. |
Name |
Description |
AddObject |
Adds an object (image, shape or chart) to the current presentation slide. |
ApplyLayout |
Applies the specified layout to the current slide. |
ApplyTheme |
Applies the specified theme to the current slide. |
ClearBackground |
Clears the slide background. |
Copy |
Creates a copy of the current slide object. |
Delete |
Deletes the current slide from the presentation. |
Duplicate |
Creates a duplicate of the specified slide object, adds the new slide to the slides collection. |
FollowLayoutBackground |
Sets the layout background as the background of the slide. |
FollowMasterBackground |
Sets the master background as the background of the slide. |
GetAllCharts |
Returns an array with all the chart objects from the slide. |
GetAllDrawings |
Returns an array with all the drawing objects from the slide. |
GetAllImages |
Returns an array with all the image objects from the slide. |
GetAllShapes |
Returns an array with all the shape objects from the slide. |
GetClassType |
Returns the type of the ApiSlide class. |
GetHeight |
Returns the slide height in English measure units. |
GetLayout |
Returns a layout of the current slide. |
GetSlideIndex |
Returns a position of the current slide in the presentation. |
GetTheme |
Returns a theme of the current slide. |
GetWidth |
Returns the slide width in English measure units. |
MoveTo |
Moves the current slide to a specific location within the same collection. |
RemoveAllObjects |
Removes all the objects from the current slide. |
RemoveObject |
Removes objects (image, shape or chart) from the current slide. |
SetBackground |
Sets the background to the current presentation slide. |
Name |
Description |
GetClassType |
Returns a type of the ApiStroke class. |
Name |
Description |
AddColumn |
Adds a new column to the end of the current table. |
AddElement |
Adds a paragraph or a table or a blockLvl content control using its position in the cell. |
AddRow |
Adds a new row to the current table. |
Copy |
Creates a copy of the current table. |
GetClassType |
Returns the type of the ApiTable object. |
GetRow |
Returns a row by its index. |
MergeCells |
Merges an array of cells. If merge is successful, it will return merged cell, otherwise "null".
Warning: The number of cells in any row and the number of rows in the current table may be changed. |
RemoveColumn |
Removes a table column with the specified cell. |
RemoveRow |
Removes a table row with the specified cell. |
Select |
Selects the current table. |
SetShd |
Specifies the shading which shall be applied to the extents of the current table. |
SetTableLook |
Specifies the components of the conditional formatting of the referenced table style (if one exists)
which shall be applied to the set of table rows with the current table-level property exceptions. A table style
can specify up to six different optional conditional formats [Example: Different formatting for first column],
which then can be applied or omitted from individual table rows in the parent table.
The default setting is to apply the row and column banding formatting, but not the first row, last row, first
column, or last column formatting. |
Name |
Description |
GetClassType |
Returns the type of the ApiTableCell class. |
GetContent |
Returns the current cell content. |
SetCellBorderBottom |
Sets the border which shall be displayed at the bottom of the current table cell. |
SetCellBorderLeft |
Sets the border which shall be displayed at the left of the current table cell. |
SetCellBorderRight |
Sets the border which shall be displayed at the right of the current table cell. |
SetCellBorderTop |
Sets the border which shall be displayed at the top of the current table cell. |
SetCellMarginBottom |
Specifies an amount of space which shall be left between the bottom extent of the cell contents and the border
of a specific individual table cell within a table. |
SetCellMarginLeft |
Specifies an amount of space which shall be left between the left extent of the current cell contents and the
left edge border of a specific individual table cell within a table. |
SetCellMarginRight |
Specifies an amount of space which shall be left between the right extent of the current cell contents and the
right edge border of a specific individual table cell within a table. |
SetCellMarginTop |
Specifies an amount of space which shall be left between the top extent of the current cell contents and the
top edge border of a specific individual table cell within a table. |
SetShd |
Specifies the shading which shall be applied to the extents of the current table cell. |
SetTextDirection |
Specifies the direction of the text flow for the current table cell. |
SetVerticalAlign |
Specifies the vertical alignment for text within the current table cell. |
Name |
Description |
GetCell |
Returns a cell by its position in the current row. |
GetCellsCount |
Returns a number of cells in the current row. |
GetClassType |
Returns the type of the ApiTableRow class. |
SetHeight |
Sets the height to the current table row. |
Name |
Description |
GetClassType |
Returns a type of the ApiTextPr class. |
SetBold |
Sets the bold property to the text character. |
SetCaps |
Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. |
SetDoubleStrikeout |
Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. |
SetFill |
Sets the text color to the current text run. |
SetFontFamily |
Sets all 4 font slots with the specified font family. |
SetFontSize |
Sets the font size to the characters of the current text run. |
SetItalic |
Sets the italic property to the text character. |
SetSmallCaps |
Specifies that all the small letter characters in the text run are formatted for display only as their capital
letter character equivalents which are two points smaller than the actual font size specified for this text. |
SetSpacing |
Sets the text spacing measured in twentieths of a point. |
SetStrikeout |
Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. |
SetUnderline |
Specifies that the contents of the run are displayed along with a line appearing directly below the character
(less than all the spacing above and below the characters on the line). |
SetVertAlign |
Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text:
- "baseline" - the characters in the current text run will be aligned by the default text baseline.
- "subscript" - the characters in the current text run will be aligned below the default text baseline.
- "superscript" - the characters in the current text run will be aligned above the default text baseline.
|
Name |
Description |
GetClassType |
Returns the type of the ApiTheme class. |
GetColorScheme |
Returns the color scheme of the current theme. |
GetFontScheme |
Returns the font scheme of the current theme. |
GetFormatScheme |
Returns the format scheme of the current theme. |
GetMaster |
Returns the slide master of the current theme. |
SetColorScheme |
Sets the color scheme to the current presentation theme. |
SetFontScheme |
Sets the font scheme to the current presentation theme. |
SetFormatScheme |
Sets the format scheme to the current presentation theme. |
Name |
Description |
ChangeColor |
Changes a color in the theme color scheme. |
Copy |
Creates a copy of the current theme color scheme. |
GetClassType |
Returns the type of the ApiThemeColorScheme class. |
SetSchemeName |
Sets a name to the current theme color scheme. |
Name |
Description |
Copy |
Creates a copy of the current theme font scheme. |
GetClassType |
Returns the type of the ApiThemeFontScheme class. |
SetFonts |
Sets the fonts to the current theme font scheme. |
SetSchemeName |
Sets a name to the current theme font scheme. |
Name |
Description |
ChangeBgFillStyles |
Sets the background fill styles to the current theme format scheme. |
ChangeEffectStyles |
Need to do
Sets the effect styles to the current theme format scheme. |
ChangeFillStyles |
Sets the fill styles to the current theme format scheme. |
ChangeLineStyles |
Sets the line styles to the current theme format scheme. |
Copy |
Creates a copy of the current theme format scheme. |
GetClassType |
Returns the type of the ApiThemeFormatScheme class. |
SetSchemeName |
Sets a name to the current theme format scheme. |
Name |
Description |
GetClassType |
Returns a type of the ApiUniColor class. |
Name |
Description |
CreateCheckBoxForm |
Creates a checkbox/radio button form with the specified checkbox/radio button form properties. |
CreateComboBoxForm |
Creates a combo box/dropdown form with the specified combo box/dropdown form properties. |
CreatePictureForm |
Creates a picture form with the specified picture form properties. |
CreateTextForm |
Creates a text form with the specified text form properties. |
|