ApiDrawing
Represents the ApiDrawing class.
Methods
Method | Returns | Description |
---|---|---|
AddBreak | boolean | Inserts a break at the specified location in the main document. |
Copy | ApiDrawing | Copies the current graphic object. |
Delete | boolean | Deletes the current graphic object. |
Fill | boolean | Sets the fill formatting properties to the current graphic object. |
GetClassType | "drawing" | Returns a type of the ApiDrawing class. |
GetContent | ApiDocumentContent | Returns the drawing inner contents where a paragraph or text runs can be inserted if it exists. |
GetHeight | EMU | Returns the height of the current drawing. |
GetLockValue | boolean | Returns the lock value for the specified lock type of the current drawing. |
GetNextDrawing | ApiDrawing | null | Returns the next inline drawing object if exists. |
GetParentContentControl | ApiBlockLvlSdt | null | Returns a parent content control that contains the graphic object. |
GetParentParagraph | ApiParagraph | null | Returns a parent paragraph that contains the graphic object. |
GetParentTable | ApiTable | null | Returns a parent table that contains the graphic object. |
GetParentTableCell | ApiTableCell | null | Returns a parent table cell that contains the graphic object. |
GetPrevDrawing | ApiDrawing | null | Returns the previous inline drawing object if exists. |
GetWidth | EMU | Returns the width of the current drawing. |
InsertInContentControl | ApiDrawing | ApiBlockLvlSdt | Wraps the graphic object with a rich text content control. |
InsertParagraph | ApiParagraph | ApiDrawing | Inserts a paragraph at the specified position. |
ScaleHeight | boolean | Scales the height of the figure using the specified coefficient. |
ScaleWidth | boolean | Scales the width of the figure using the specified coefficient. |
Select | None | Selects the current graphic object. |
SetDistances | None | Specifies the minimum distance which will be maintained between the edges of the current drawing object and any\ subsequent text. |
SetDrawingPrFromDrawing | boolean | Sets the properties from another drawing to the current drawing.\ The following properties will be copied: horizontal and vertical alignment, distance between the edges of the current drawing object and any subsequent text, wrapping style, drawing name, title and description. |
SetHorAlign | None | Specifies how the floating object will be horizontally aligned. |
SetHorFlip | None | Flips the current drawing horizontally. |
SetHorPosition | None | Sets the absolute measurement for the horizontal positioning of the floating object. |
SetLockValue | boolean | Sets the lock value to the specified lock type of the current drawing. |
SetOutLine | boolean | Sets the outline properties to the specified graphic object. |
SetSize | None | Sets the size of the object (image, shape, chart) bounding box. |
SetVerAlign | None | Specifies how the floating object will be vertically aligned. |
SetVerPosition | None | Sets the absolute measurement for the vertical positioning of the floating object. |
SetVertFlip | boolean | Flips the current drawing vertically. |
SetWrappingStyle | None | 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. |
ToJSON | JSON | Converts the ApiDrawing object into the JSON object. |