IXlsVectorShape
COM interface ( getting help with interfaces )

 

interface IXlsVectorShape : IDispatch
{
  [id(1),propget]  HRESULT Type([out, retval]enumVectorShape* vectorShapeType);
  [id(2),propput]  HRESULT Label([in]BSTR label);
  [id(2),propget]  HRESULT Label([out, retval]BSTR* label);
  [id(3),propput]  HRESULT RichLabel([in]IXlsRichLabel* rl);
  [id(4),propput]  HRESULT Hyperlink([in]IXlsHyperlink* hlink);
  [id(5),propget]  HRESULT AutoSize([out, retval] BOOL* autosize);
  [id(5),propput]  HRESULT AutoSize([in]BOOL autosize);
  [id(6),propput]  HRESULT Formula([in]BSTR formula);
  [id(6),propget]  HRESULT Formula([out, retval]BSTR* formula);
  [id(7),propget]  HRESULT AlternativeText([out, retval]BSTR* text);
  [id(7),propput]  HRESULT AlternativeText([in]BSTR text);
  [id(8),propput]  HRESULT Style([in]IXlsStyle* style);
  [id(9),propget]  HRESULT LeftColumn([out, retval]int* col1);
  [id(9),propput]  HRESULT LeftColumn([in]int col1);
  [id(10),propget] HRESULT RightColumn([out, retval]int* col2);
  [id(10),propput] HRESULT RightColumn([in]int col2);
  [id(11),propget] HRESULT TopCell([out, retval]int* row1);
  [id(11),propput] HRESULT TopCell([in]int row1);
  [id(12),propget] HRESULT BottomCell([out, retval]int* row2);
  [id(12),propput] HRESULT BottomCell([in]int row2);
  [id(13),propget] HRESULT LeftOffset([out, retval]int* offset);
  [id(13),propput] HRESULT LeftOffset([in]int offset);
  [id(14),propget] HRESULT RightOffset([out, retval]int* offset);
  [id(14),propput] HRESULT RightOffset([in]int offset);
  [id(15),propget] HRESULT TopOffset([out, retval]int* offset);
  [id(15),propput] HRESULT TopOffset([in]int offset);
  [id(16),propget] HRESULT BottomOffset([out, retval]int* offset);
  [id(16),propput] HRESULT BottomOffset([in]int offset);
  [id(17)        ] HRESULT Delete();
  [id(18),propget] HRESULT FlipHorizontal([out, retval] BOOL* flipHorz);
  [id(18),propput] HRESULT FlipHorizontal([in]BOOL flipHorz);
  [id(19),propget] HRESULT FlipVertical([out, retval] BOOL* flipVert);
  [id(19),propput] HRESULT FlipVertical([in]BOOL flipVert);
  [id(20),propget] HRESULT Rotation([out, retval] int* angle);
  [id(20),propput] HRESULT Rotation([in]int angle);
  [id(21),propget] HRESULT ArrowStyleBeginCap([out, retval] IXlsVectorShapeArrow** beginCap);
  [id(22),propget] HRESULT ArrowStyleEndCap([out, retval] IXlsVectorShapeArrow** endCap);
  [id(23),propget] HRESULT Patterns([out, retval]IXlsChartPatterns** patterns);
  [id(24)        ] HRESULT ExtractToFile([out, retval]BSTR* filename);
  [id(25)        ] HRESULT ExtractToMemory([in]IUnknown* lockbytes);
  [id(26),propget] HRESULT AdjustValue([out, retval]int* value);
  [id(26),propput] HRESULT AdjustValue([in]int value);
  [id(27),propput] HRESULT MarginLeft([in]int pixels);
  [id(28),propput] HRESULT MarginRight([in]int pixels);
  [id(29),propput] HRESULT MarginTop([in]int pixels);
  [id(30),propput] HRESULT MarginBottom([in]int pixels);
  [id(31),propput] HRESULT VBAMacro([in]BSTR macro);
  [id(31),propget] HRESULT VBAMacro([out, retval]BSTR* macro);
  [id(32),propget] HRESULT Name([out, retval] BSTR* name);
  [id(32),propput] HRESULT Name([in] BSTR name);

}

 

HRESULT Type([out, retval]enumVectorShape* vectorShapeType);
returns the vector shape type.

HRESULT Label([in]BSTR label);
sets the content of the vector shape.

HRESULT Label([out, retval]BSTR* label);
returns the content of the vector shape.

HRESULT RichLabel([in]IXlsRichLabel* rl);
sets the content of the vector shape using richly formatting labels.

HRESULT Hyperlink([in]IXlsHyperlink* hlink);
adds a hyperlink to the vector shape.

HRESULT AutoSize([out, retval] BOOL* autosize);
returns whether the text box should auto scale to fit the text. This option is ignored if the text box is part of an Excel 2007 file.

HRESULT AutoSize([in]BOOL autosize);
sets whether the text box should auto scale to fit the text. This option is ignored if the text box is part of an Excel 2007 file.

HRESULT Formula([in]BSTR formula);
sets the formula for the vector shape.

HRESULT Formula([out, retval]BSTR* formula);
returns the formula for the vector shape.

HRESULT AlternativeText([out, retval]BSTR* text);
returns the alternative text. Optional.

HRESULT AlternativeText([in]BSTR text);
sets the alternative text. Optional.

HRESULT Style([in]IXlsStyle* style);
associates a style to the vector shape.

HRESULT LeftColumn([out, retval]int* col1);
returns the left worksheet column of the vector shape.

HRESULT LeftColumn([in]int col1);
sets the left worksheet column of the vector shape.

HRESULT RightColumn([out, retval]int* col2);
returns the right worksheet column of the vector shape.

HRESULT RightColumn([in]int col2);
sets the right worksheet column of the vector shape.

HRESULT TopCell([out, retval]int* row1);
returns the top worksheet row of the vector shape.

HRESULT TopCell([in]int row1);
sets the top worksheet row of the vector shape.

HRESULT BottomCell([out, retval]int* row2);
returns the bottom worksheet row of the vector shape.

HRESULT BottomCell([in]int row2);
sets the bottom worksheet row of the vector shape.

HRESULT LeftOffset([out, retval]int* offset);
returns the left worksheet column offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT LeftOffset([in]int offset);
sets the left worksheet column offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT RightOffset([out, retval]int* offset);
returns the right worksheet column offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT RightOffset([in]int offset);
sets the right worksheet column offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT TopOffset([out, retval]int* offset);
returns the top worksheet row offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT TopOffset([in]int offset);
sets the top worksheet row offset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT BottomOffset([out, retval]int* offset);
returns the bottom worksheet rowoffset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT BottomOffset([in]int offset);
sets the bottom worksheet rowoffset of the vector shape. Value is 0 if it coincides with the worksheet grid.

HRESULT Delete();
deletes the vector shape.

HRESULT FlipHorizontal([out, retval] BOOL* flipHorz);
returns whether the vector shape is flipped horizontally.

HRESULT FlipHorizontal([in]BOOL flipHorz);
sets whether the vector shape is flipped horizontally.

HRESULT FlipVertical([out, retval] BOOL* flipVert);
returns whether the vector shape is flipped vertically.

HRESULT FlipVertical([in]BOOL flipVert);
sets whether the vector shape is flipped vertically.

HRESULT Rotation([out, retval] int* angle);
returns the rotation angle of the vector shape. Default is 0 degree.

HRESULT Rotation([in]int angle);
sets the rotation angle of the vector shape. Default is 0 degree.

HRESULT ArrowStyleBeginCap([out, retval] IXlsVectorShapeArrow** beginCap);
returns the arrow style of the begin cap. Only applies to lines.

HRESULT ArrowStyleEndCap([out, retval] IXlsVectorShapeArrow** endCap);
returns the arrow style of the end cap. Only applies to lines.

HRESULT Patterns([out, retval]IXlsChartPatterns** patterns);
returns the patterns object.

HRESULT ExtractToFile([out, retval]BSTR* filename);
creates a copy of the rendered vector shape in a file and returns the filename. Client applications must be ready to accept the PNG file format.

HRESULT ExtractToMemory([in]IUnknown* lockbytes);
creates a copy of the rendered vector shape in memory. PNG buffer.

HRESULT AdjustValue([out, retval]int* value);
returns the adjust value used to tweak the vector shape (for instance the skewness of a parallelogram). The value must be greater than 0.

HRESULT AdjustValue([in]int value);
sets the adjust value used to tweak the vector shape (for instance the skewness of a parallelogram). The value must be greater than 0.

HRESULT MarginLeft([in]int pixels);
sets the left margin inside the text of the vector shape, in pixels. Default is : automatic margin computation.

HRESULT MarginRight([in]int pixels);
sets the right margin inside the text of the vector shape, in pixels. Default is : automatic margin computation.

HRESULT MarginTop([in]int pixels);
sets the top margin inside the text of the vector shape, in pixels. Default is : automatic margin computation.

HRESULT MarginBottom([in]int pixels);
sets the bottom margin inside the text of the vector shape, in pixels. Default is : automatic margin computation.

HRESULT VBAMacro([in]BSTR macro);
sets the vba macro name for the vector shape.

HRESULT VBAMacro([out, retval]BSTR* macro);
returns the vba macro name for the vector shape.

HRESULT Name([out, retval] BSTR* name);
retrieves the name of the vector shape.

HRESULT Name([in] BSTR name);
sets the name of the vector shape.