Aspose::Slides::Table Class Referencefinal

Represents a table on a slide. More...

Inherits Aspose::Slides::GraphicalObject, and Aspose::Slides::ITable.

Public Member Functions

System::SharedPtr< IRowCollectionget_Rows () override
 Returns the collectoin of rows. Read-only IRowCollection. More...
 
System::SharedPtr< IColumnCollectionget_Columns () override
 Returns the collectoin of columns. Read-only IColumnCollection. More...
 
System::SharedPtr< ITableFormatget_TableFormat () override
 Returns the TableFormat object that contains formatting properties for this table. Read-only ITableFormat. More...
 
TableStylePreset get_StylePreset () override
 Gets builtin table style. Read TableStylePreset. More...
 
void set_StylePreset (TableStylePreset value) override
 Sets builtin table style. Write TableStylePreset. More...
 
bool get_RightToLeft () override
 Determines whether the table has right to left reading order. Reads bool. More...
 
void set_RightToLeft (bool value) override
 Determines whether the table has right to left reading order. Writes bool. More...
 
bool get_FirstRow () override
 Determines whether the first row of a table has to be drawn with a special formatting. Read bool. More...
 
void set_FirstRow (bool value) override
 Determines whether the first row of a table has to be drawn with a special formatting. Write bool. More...
 
bool get_FirstCol () override
 Determines whether the first column of a table has to be drawn with a special formatting. Read bool. More...
 
void set_FirstCol (bool value) override
 Determines whether the first column of a table has to be drawn with a special formatting. Write bool. More...
 
bool get_LastRow () override
 Determines whether the last row of a table has to be drawn with a special formatting. Read bool. More...
 
void set_LastRow (bool value) override
 Determines whether the last row of a table has to be drawn with a special formatting. Write bool. More...
 
bool get_LastCol () override
 Determines whether the last column of a table has to be drawn with a special formatting. Read bool. More...
 
void set_LastCol (bool value) override
 Determines whether the last column of a table has to be drawn with a special formatting. Write bool. More...
 
bool get_HorizontalBanding () override
 Determines whether the even rows has to be drawn with a different formatting. Read bool. More...
 
void set_HorizontalBanding (bool value) override
 Determines whether the even rows has to be drawn with a different formatting. Write bool. More...
 
bool get_VerticalBanding () override
 Determines whether the even columns has to be drawn with a different formatting. Read bool. More...
 
void set_VerticalBanding (bool value) override
 Determines whether the even columns has to be drawn with a different formatting. Write bool. More...
 
System::SharedPtr< IFillFormatget_FillFormat () override
 Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don't have fill properties. Read-only IFillFormat. More...
 
System::SharedPtr< ICellidx_get (int32_t columnIndex, int32_t rowIndex) override
 Returns the cell at the specified column and row indexes. Read-only Cell. More...
 
System::SharedPtr< ICellMergeCells (System::SharedPtr< ICell > cell1, System::SharedPtr< ICell > cell2, bool allowSplitting) override
 Merges neighbour cells. More...
 
void SetTextFormat (System::SharedPtr< IPortionFormat > source) override
 Sets defined portion format properties to all table cells' portions. More...
 
void SetTextFormat (System::SharedPtr< IParagraphFormat > source) override
 Sets defined paragraph format properties to all table cells' paragraphs. More...
 
void SetTextFormat (System::SharedPtr< ITextFrameFormat > source) override
 Sets defined text frame format properties to all table cells' text frames. More...
 
- Public Member Functions inherited from Aspose::Slides::GraphicalObject
System::SharedPtr< IGraphicalObjectLockget_GraphicalObjectLock () override
 Returns shape's locks. Read-only IGraphicalObjectLock. More...
 
- Public Member Functions inherited from Aspose::Slides::Shape
bool get_IsTextHolder () override
 Determines whether the shape is TextHolder_PPT. Read-only bool. More...
 
System::SharedPtr< IPlaceholderget_Placeholder () override
 Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder. More...
 
System::SharedPtr< ICustomDataget_CustomData () override
 Returns the shape's custom data. Read-only ICustomData. More...
 
System::SharedPtr< IShapeFrameget_RawFrame () override
 Returns the raw shape frame's properties. Read IShapeFrame. More...
 
void set_RawFrame (System::SharedPtr< IShapeFrame > value) override
 Sets the raw shape frame's properties. Write IShapeFrame. More...
 
System::SharedPtr< IShapeFrameget_Frame () override
 Returns the shape frame's properties. Read IShapeFrame. More...
 
void set_Frame (System::SharedPtr< IShapeFrame > value) override
 Sets the shape frame's properties. Write IShapeFrame. More...
 
System::SharedPtr< ILineFormatget_LineFormat () override
 Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don't have line properties. Read-only ILineFormat. More...
 
System::SharedPtr< IThreeDFormatget_ThreeDFormat () override
 Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don't have 3d properties. Read-only IThreeDFormat. More...
 
System::SharedPtr< IEffectFormatget_EffectFormat () override
 Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don't have effect properties. Read-only IEffectFormat. More...
 
System::SharedPtr< IHyperlinkget_HyperlinkClick () override
 Returns the hyperlink defined for mouse click. Read IHyperlink. More...
 
void set_HyperlinkClick (System::SharedPtr< IHyperlink > value) override
 Sets the hyperlink defined for mouse click. Write IHyperlink. More...
 
System::SharedPtr< IHyperlinkget_HyperlinkMouseOver () override
 Returns the hyperlink defined for mouse over. Read IHyperlink. More...
 
void set_HyperlinkMouseOver (System::SharedPtr< IHyperlink > value) override
 Sets the hyperlink defined for mouse over. Write IHyperlink. More...
 
System::SharedPtr< IHyperlinkManagerget_HyperlinkManager () override
 Returns the hyperlink manager. Read-only IHyperlinkManager. More...
 
bool get_Hidden () override
 Determines whether the shape is hidden. Read bool. More...
 
void set_Hidden (bool value) override
 Determines whether the shape is hidden. Write bool. More...
 
int32_t get_ZOrderPosition () override
 Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int32_t. More...
 
int32_t get_ConnectionSiteCount () override
 Returns the number of connection sites on the shape. Read-only int32_t. More...
 
float get_Rotation () override
 Returns the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read float. More...
 
void set_Rotation (float value) override
 Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Write float. More...
 
float get_X () override
 Returns the x-coordinate of the upper-left corner of the shape. Read float. More...
 
void set_X (float value) override
 Sets the x-coordinate of the upper-left corner of the shape. Write float. More...
 
float get_Y () override
 Returns the y-coordinate of the upper-left corner of the shape. Read float. More...
 
void set_Y (float value) override
 Sets the y-coordinate of the upper-left corner of the shape. Write float. More...
 
float get_Width () override
 Returns the width of the shape. Read float. More...
 
void set_Width (float value) override
 Sets the width of the shape. Write float. More...
 
float get_Height () override
 Returns the height of the shape. Read float. More...
 
void set_Height (float value) override
 Sets the height of the shape. Write float. More...
 
Aspose::Slides::BlackWhiteMode get_BlackWhiteMode () override
 Property specifies how a shape will render in black-and-white display mode.. Read Slides::BlackWhiteMode. More...
 
void set_BlackWhiteMode (Aspose::Slides::BlackWhiteMode value) override
 Property specifies how a shape will render in black-and-white display mode.. Write Slides::BlackWhiteMode. More...
 
uint32_t get_UniqueId () override
 Gets unique shape identifier in presentation scope. Read-only uint32_t. See also Shape::get_OfficeInteropShapeId for getting unique shape identifier in slide scope. More...
 
uint32_t get_OfficeInteropShapeId () override
 Gets unique shape identifier in slide scope. Read-only uint32_t. See also Shape::get_UniqueId for getting unique shape identifier in presentation scope. More...
 
System::String get_AlternativeText () override
 Returns the alternative text associated with a shape. Read System::String. More...
 
void set_AlternativeText (System::String value) override
 Sets the alternative text associated with a shape. Write System::String. More...
 
System::String get_AlternativeTextTitle () override
 Returns the title of alternative text associated with a shape. Read System::String. More...
 
void set_AlternativeTextTitle (System::String value) override
 Sets the title of alternative text associated with a shape. Write System::String. More...
 
System::String get_Name () override
 Returns the name of a shape. Must be not null. Use empty string value if needed. Read System::String. More...
 
void set_Name (System::String value) override
 Sets the name of a shape. Must be not null. Use empty string value if needed. Write System::String. More...
 
System::SharedPtr< IBaseShapeLockget_ShapeLock () override
 Returns shape's locks. Read-only IBaseShapeLock. More...
 
bool get_IsGrouped () override
 Determines whether the shape is grouped. Read-only bool. More...
 
System::SharedPtr< IGroupShapeget_ParentGroup () override
 Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. More...
 
System::SharedPtr< IBaseSlideget_Slide () override
 Returns the parent slide of a shape. Read-only IBaseSlide. More...
 
System::SharedPtr< IPresentationget_Presentation () override
 Returns the parent presentation of a slide. Read-only IPresentation. More...
 
void RemovePlaceholder () override
 Defines that this shape isn't a placeholder. More...
 
System::SharedPtr< IPlaceholderAddPlaceholder (System::SharedPtr< IPlaceholder > placeholderToCopyFrom) override
 Adds a new placeholder if there is no and sets placeholder properties to a specified one. More...
 
System::SharedPtr< System::Drawing::BitmapGetThumbnail () override
 Returns shape thumbnail. ShapeThumbnailBounds::Shape shape thumbnail bounds type is used by default. More...
 
System::SharedPtr< System::Drawing::BitmapGetThumbnail (ShapeThumbnailBounds bounds, float scaleX, float scaleY) override
 Returns shape thumbnail. More...
 
void WriteAsSvg (System::SharedPtr< System::IO::Stream > stream) override
 Saves content of Shape as SVG file. More...
 
void WriteAsSvg (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Export::ISVGOptions > svgOptions) override
 Saves content of Shape as SVG file. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

void SetRawFrameImpl (System::SharedPtr< PresentationML::Transform2D > value) override
 
void Reset () override
 Sets all formats to NotDefined state. For shapes with placeholders this will cause default state. More...
 
void ConfirmTextFrameIsFittedToShape () override
 
void Draw (System::SharedPtr< Drawing::Canvas > canvas, System::SharedPtr< Drawing::RenderContext > rc, System::SharedPtr< InterruptionToken > interruptionToken) override
 
void ScaleGeometry (float scalingCoefX, float scalingCoefY, float scalingContentCoef) override
 
void ProcessFitShapeToText () override
 
System::SharedPtr< IFillFormatEffectiveDataCreateFillFormatEffectiveImpl () override
 
virtual ~Table ()
 
- Protected Member Functions inherited from Aspose::Slides::GraphicalObject
bool get_MetroBlobRequired () override
 Shows if saving this shape to ppt requires GroupShapeMetroBlob record to save all shape's properties correctly More...
 
- Protected Member Functions inherited from Aspose::Slides::Shape
virtual ~Shape ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents a table on a slide.

Constructor & Destructor Documentation

◆ ~Table()

virtual Aspose::Slides::Table::~Table ( )
protectedvirtual

Member Function Documentation

◆ ConfirmTextFrameIsFittedToShape()

void Aspose::Slides::Table::ConfirmTextFrameIsFittedToShape ( )
overrideprotected

◆ CreateFillFormatEffectiveImpl()

System::SharedPtr<IFillFormatEffectiveData> Aspose::Slides::Table::CreateFillFormatEffectiveImpl ( )
overrideprotected

◆ Draw()

void Aspose::Slides::Table::Draw ( System::SharedPtr< Drawing::Canvas >  canvas,
System::SharedPtr< Drawing::RenderContext >  rc,
System::SharedPtr< InterruptionToken interruptionToken 
)
overrideprotected

◆ get_Columns()

System::SharedPtr<IColumnCollection> Aspose::Slides::Table::get_Columns ( )
overridevirtual

Returns the collectoin of columns. Read-only IColumnCollection.

Implements Aspose::Slides::ITable.

◆ get_FillFormat()

System::SharedPtr<IFillFormat> Aspose::Slides::Table::get_FillFormat ( )
overridevirtual

Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don't have fill properties. Read-only IFillFormat.

Deprecated:
Use Table.TableFormat.FillFormat instead. The property will be returning null after release of version 20.8.

Reimplemented from Aspose::Slides::Shape.

◆ get_FirstCol()

bool Aspose::Slides::Table::get_FirstCol ( )
overridevirtual

Determines whether the first column of a table has to be drawn with a special formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ get_FirstRow()

bool Aspose::Slides::Table::get_FirstRow ( )
overridevirtual

Determines whether the first row of a table has to be drawn with a special formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ get_HorizontalBanding()

bool Aspose::Slides::Table::get_HorizontalBanding ( )
overridevirtual

Determines whether the even rows has to be drawn with a different formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ get_LastCol()

bool Aspose::Slides::Table::get_LastCol ( )
overridevirtual

Determines whether the last column of a table has to be drawn with a special formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ get_LastRow()

bool Aspose::Slides::Table::get_LastRow ( )
overridevirtual

Determines whether the last row of a table has to be drawn with a special formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ get_RightToLeft()

bool Aspose::Slides::Table::get_RightToLeft ( )
overridevirtual

Determines whether the table has right to left reading order. Reads bool.

Implements Aspose::Slides::ITable.

◆ get_Rows()

System::SharedPtr<IRowCollection> Aspose::Slides::Table::get_Rows ( )
overridevirtual

Returns the collectoin of rows. Read-only IRowCollection.

Implements Aspose::Slides::ITable.

◆ get_StylePreset()

TableStylePreset Aspose::Slides::Table::get_StylePreset ( )
overridevirtual

Gets builtin table style. Read TableStylePreset.

Implements Aspose::Slides::ITable.

◆ get_TableFormat()

System::SharedPtr<ITableFormat> Aspose::Slides::Table::get_TableFormat ( )
overridevirtual

Returns the TableFormat object that contains formatting properties for this table. Read-only ITableFormat.

Implements Aspose::Slides::ITable.

◆ get_VerticalBanding()

bool Aspose::Slides::Table::get_VerticalBanding ( )
overridevirtual

Determines whether the even columns has to be drawn with a different formatting. Read bool.

Implements Aspose::Slides::ITable.

◆ idx_get()

System::SharedPtr<ICell> Aspose::Slides::Table::idx_get ( int32_t  columnIndex,
int32_t  rowIndex 
)
overridevirtual

Returns the cell at the specified column and row indexes. Read-only Cell.

Implements Aspose::Slides::ITable.

◆ MergeCells()

System::SharedPtr<ICell> Aspose::Slides::Table::MergeCells ( System::SharedPtr< ICell cell1,
System::SharedPtr< ICell cell2,
bool  allowSplitting 
)
overridevirtual

Merges neighbour cells.

Parameters
cell1Cell to merge.
cell2Cell to merge.
allowSplittingTrue to allow cells splitting.
Returns
Merged cell.

Implements Aspose::Slides::ITable.

◆ ProcessFitShapeToText()

void Aspose::Slides::Table::ProcessFitShapeToText ( )
overrideprotected

◆ Reset()

void Aspose::Slides::Table::Reset ( )
overrideprotected

Sets all formats to NotDefined state. For shapes with placeholders this will cause default state.

◆ ScaleGeometry()

void Aspose::Slides::Table::ScaleGeometry ( float  scalingCoefX,
float  scalingCoefY,
float  scalingContentCoef 
)
overrideprotected

◆ set_FirstCol()

void Aspose::Slides::Table::set_FirstCol ( bool  value)
overridevirtual

Determines whether the first column of a table has to be drawn with a special formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ set_FirstRow()

void Aspose::Slides::Table::set_FirstRow ( bool  value)
overridevirtual

Determines whether the first row of a table has to be drawn with a special formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ set_HorizontalBanding()

void Aspose::Slides::Table::set_HorizontalBanding ( bool  value)
overridevirtual

Determines whether the even rows has to be drawn with a different formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ set_LastCol()

void Aspose::Slides::Table::set_LastCol ( bool  value)
overridevirtual

Determines whether the last column of a table has to be drawn with a special formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ set_LastRow()

void Aspose::Slides::Table::set_LastRow ( bool  value)
overridevirtual

Determines whether the last row of a table has to be drawn with a special formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ set_RightToLeft()

void Aspose::Slides::Table::set_RightToLeft ( bool  value)
overridevirtual

Determines whether the table has right to left reading order. Writes bool.

Implements Aspose::Slides::ITable.

◆ set_StylePreset()

void Aspose::Slides::Table::set_StylePreset ( TableStylePreset  value)
overridevirtual

Sets builtin table style. Write TableStylePreset.

Implements Aspose::Slides::ITable.

◆ set_VerticalBanding()

void Aspose::Slides::Table::set_VerticalBanding ( bool  value)
overridevirtual

Determines whether the even columns has to be drawn with a different formatting. Write bool.

Implements Aspose::Slides::ITable.

◆ SetRawFrameImpl()

void Aspose::Slides::Table::SetRawFrameImpl ( System::SharedPtr< PresentationML::Transform2D >  value)
overrideprotected

◆ SetTextFormat() [1/3]

void Aspose::Slides::Table::SetTextFormat ( System::SharedPtr< IParagraphFormat source)
overridevirtual

Sets defined paragraph format properties to all table cells' paragraphs.

Parameters
sourceIParagraphFormat object with necessary properties set.

Implements Aspose::Slides::IBulkTextFormattable.

◆ SetTextFormat() [2/3]

void Aspose::Slides::Table::SetTextFormat ( System::SharedPtr< IPortionFormat source)
overridevirtual

Sets defined portion format properties to all table cells' portions.

Parameters
sourceIPortionFormat object with necessary properties set.

Implements Aspose::Slides::IBulkTextFormattable.

◆ SetTextFormat() [3/3]

void Aspose::Slides::Table::SetTextFormat ( System::SharedPtr< ITextFrameFormat source)
overridevirtual

Sets defined text frame format properties to all table cells' text frames.

Parameters
sourceITextFrameFormat object with necessary properties set.

Implements Aspose::Slides::IBulkTextFormattable.