Represents a field in a PivotTable report. More...

Inherits Object.

Public Member Functions
virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotItemCollection >	GetIPivotItems ()=0
	Gets the pivot items of the pivot field More...

virtual intrusive_ptr< Aspose::Cells::Pivot::ISxRng >	GetIRange ()=0
	Gets the group range of the pivot field More...

virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotFilter >	GetIPivotFilterByType (Aspose::Cells::Pivot::PivotFilterType type)=0
	Gets the pivot filter of the pivot field by type More...

virtual intrusive_ptr< Aspose::Cells::Systems::Collections::ArrayList >	GetPivotFilters ()=0
	Gets the pivot filters of the pivot field More...

virtual void	InitPivotItems ()=0
	Init the pivot items of the pivot field More...

virtual bool	IsCalculatedField ()=0
	Indicates whether the specified PivotTable field is calculated field. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetCalculatedFieldFormula ()=0
	Get the formula string of the specified calculated field . More...

virtual Aspose::Cells::Systems::Int32	GetBaseIndex ()=0
	Represents the PivotField index in the base PivotFields. More...

virtual void	SetBaseIndex (Aspose::Cells::Systems::Int32 value)=0
	Represents the PivotField index in the base PivotFields. More...

virtual Aspose::Cells::Systems::Int32	GetPosition ()=0
	Represents the PivotField index in the PivotFields. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetName ()=0
	Represents the PivotField name. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetDisplayName ()=0
	Represents the PivotField display name. More...

virtual void	SetDisplayName (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Represents the PivotField display name. More...

virtual void	SetSubtotals (Aspose::Cells::Pivot::PivotFieldSubtotalType subtotalType, bool shown)=0
	Sets whether the specified field shows that subtotals. More...

virtual bool	GetSubtotals (Aspose::Cells::Pivot::PivotFieldSubtotalType subtotalType)=0
	Gets whether the specified field shows that subtotals. More...

virtual bool	IsAutoSubtotals ()=0
	Indicates whether the specified field shows automatic subtotals. Default is true. More...

virtual void	SetAutoSubtotals (bool value)=0
	Indicates whether the specified field shows automatic subtotals. Default is true. More...

virtual bool	GetDragToColumn ()=0
	Indicates whether the specified field can be dragged to the column position. The default value is true. More...

virtual void	SetDragToColumn (bool value)=0
	Indicates whether the specified field can be dragged to the column position. The default value is true. More...

virtual bool	GetDragToHide ()=0
	Indicates whether the specified field can be dragged to the hide position. The default value is true. More...

virtual void	SetDragToHide (bool value)=0
	Indicates whether the specified field can be dragged to the hide position. The default value is true. More...

virtual bool	GetDragToRow ()=0
	Indicates whether the specified field can be dragged to the row position. The default value is true. More...

virtual void	SetDragToRow (bool value)=0
	Indicates whether the specified field can be dragged to the row position. The default value is true. More...

virtual bool	GetDragToPage ()=0
	Indicates whether the specified field can be dragged to the page position. The default value is true. More...

virtual void	SetDragToPage (bool value)=0
	Indicates whether the specified field can be dragged to the page position. The default value is true. More...

virtual bool	GetDragToData ()=0
	Indicates whether the specified field can be dragged to the data position. The default value is true. More...

virtual void	SetDragToData (bool value)=0
	Indicates whether the specified field can be dragged to the data position. The default value is true. More...

virtual bool	IsMultipleItemSelectionAllowed ()=0
	indicates whether the field can have multiple items selected in the page field The default value is false. More...

virtual void	SetMultipleItemSelectionAllowed (bool value)=0
	indicates whether the field can have multiple items selected in the page field The default value is false. More...

virtual bool	IsRepeatItemLabels ()=0
	indicates whether the field can repeat items labels The default value is false. More...

virtual void	SetRepeatItemLabels (bool value)=0
	indicates whether the field can repeat items labels The default value is false. More...

virtual bool	IsIncludeNewItemsInFilter ()=0
	indicates whether the field can include new items in manual filter The default value is false. More...

virtual void	SetIncludeNewItemsInFilter (bool value)=0
	indicates whether the field can include new items in manual filter The default value is false. More...

virtual bool	IsInsertPageBreaksBetweenItems ()=0
	indicates whether the field can insert page breaks between items insert page break after each item The default value is false. More...

virtual void	SetInsertPageBreaksBetweenItems (bool value)=0
	indicates whether the field can insert page breaks between items insert page break after each item The default value is false. More...

virtual bool	GetShowAllItems ()=0
	Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false. More...

virtual void	SetShowAllItems (bool value)=0
	Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false. More...

virtual bool	GetNonAutoSortDefault ()=0
	Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. More...

virtual void	SetNonAutoSortDefault (bool value)=0
	Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. More...

virtual bool	IsAutoSort ()=0
	Indicates whether the specified PivotTable field is automatically sorted. More...

virtual void	SetAutoSort (bool value)=0
	Indicates whether the specified PivotTable field is automatically sorted. More...

virtual bool	IsAscendSort ()=0
	Indicates whether the specified PivotTable field is autosorted ascending. More...

virtual void	SetAscendSort (bool value)=0
	Indicates whether the specified PivotTable field is autosorted ascending. More...

virtual Aspose::Cells::Systems::Int32	GetAutoSortField ()=0
	Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields. More...

virtual void	SetAutoSortField (Aspose::Cells::Systems::Int32 value)=0
	Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields. More...

virtual bool	IsAutoShow ()=0
	Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003. More...

virtual void	SetAutoShow (bool value)=0
	Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003. More...

virtual bool	IsAscendShow ()=0
	Indicates whether the specified PivotTable field is autoshown ascending. More...

virtual void	SetAscendShow (bool value)=0
	Indicates whether the specified PivotTable field is autoshown ascending. More...

virtual Aspose::Cells::Systems::Int32	GetAutoShowCount ()=0
	Represent the number of top or bottom items that are automatically shown in the specified PivotTable field. More...

virtual void	SetAutoShowCount (Aspose::Cells::Systems::Int32 value)=0
	Represent the number of top or bottom items that are automatically shown in the specified PivotTable field. More...

virtual Aspose::Cells::Systems::Int32	GetAutoShowField ()=0
	Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields. More...

virtual void	SetAutoShowField (Aspose::Cells::Systems::Int32 value)=0
	Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields. More...

virtual Aspose::Cells::ConsolidationFunction	GetFunction ()=0
	Represents the function used to summarize the PivotTable data field. More...

virtual void	SetFunction (Aspose::Cells::ConsolidationFunction value)=0
	Represents the function used to summarize the PivotTable data field. More...

virtual Aspose::Cells::Pivot::PivotFieldDataDisplayFormat	GetDataDisplayFormat ()=0
	Represents how to display the values contained in a data field. More...

virtual void	SetDataDisplayFormat (Aspose::Cells::Pivot::PivotFieldDataDisplayFormat value)=0
	Represents how to display the values contained in a data field. More...

virtual Aspose::Cells::Systems::Int32	GetBaseFieldIndex ()=0
	Represents the base field for a custom calculation. More...

virtual void	SetBaseFieldIndex (Aspose::Cells::Systems::Int32 value)=0
	Represents the base field for a custom calculation. More...

virtual Aspose::Cells::Pivot::PivotItemPosition	GetBaseItemPosition ()=0
	Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute. More...

virtual void	SetBaseItemPosition (Aspose::Cells::Pivot::PivotItemPosition value)=0
	Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute. More...

virtual Aspose::Cells::Systems::Int32	GetBaseItemIndex ()=0
	Represents the item in the base field for a custom calculation. Valid only for data fields. More...

virtual void	SetBaseItemIndex (Aspose::Cells::Systems::Int32 value)=0
	Represents the item in the base field for a custom calculation. Valid only for data fields. More...

virtual Aspose::Cells::Systems::Int16	GetCurrentPageItem ()=0
	Represents the current page item showing for the page field (valid only for page fields). More...

virtual void	SetCurrentPageItem (Aspose::Cells::Systems::Int16 value)=0
	Represents the current page item showing for the page field (valid only for page fields). More...

virtual Aspose::Cells::Systems::Int32	GetNumber ()=0
	Represents the built-in display format of numbers and dates. More...

virtual void	SetNumber (Aspose::Cells::Systems::Int32 value)=0
	Represents the built-in display format of numbers and dates. More...

virtual bool	GetInsertBlankRow ()=0
	Indicates whether inserting blank line after each item. More...

virtual void	SetInsertBlankRow (bool value)=0
	Indicates whether inserting blank line after each item. More...

virtual bool	GetShowSubtotalAtTop ()=0
	when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom More...

virtual void	SetShowSubtotalAtTop (bool value)=0
	when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom More...

virtual bool	GetShowInOutlineForm ()=0
	Indicates whether layout this field in outline form on the Pivot Table view More...

virtual void	SetShowInOutlineForm (bool value)=0
	Indicates whether layout this field in outline form on the Pivot Table view More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	Get_NumberFormat ()=0
	Represents the custom display format of numbers and dates. More...

virtual void	SetNumberFormat (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Represents the custom display format of numbers and dates. More...

virtual bool	IsHiddenItem (Aspose::Cells::Systems::Int32 index)=0
	Indicates whether the specific PivotItem is hidden. More...

virtual void	HideItem (Aspose::Cells::Systems::Int32 index, bool isHidden)=0
	Sets whether the specific PivotItem in a data field is hidden. More...

virtual bool	IsHiddenItemDetail (Aspose::Cells::Systems::Int32 index)=0
	Indicates whether the specific PivotItem is hidden detail. More...

virtual void	HideItemDetail (Aspose::Cells::Systems::Int32 index, bool isHiddenDetail)=0
	Sets whether the specific PivotItem in a pivot field is hidden detail. More...

virtual void	HideDetail (bool isHiddenDetail)=0
	Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field. More...

virtual void	HideItem (intrusive_ptr< Aspose::Cells::Systems::String > itemValue, bool isHidden)=0
	Sets whether the specific PivotItem in a data field is hidden. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String * > >	GetItems ()=0
	Get all base items; More...

virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String * > >	GetOriginalItems ()=0
	Get the original base items; More...

virtual Aspose::Cells::Systems::Int32	GetItemCount ()=0
	Gets the base item count of this pivot field. More...

virtual void	AddCalculatedItem (intrusive_ptr< Aspose::Cells::Systems::String > name, intrusive_ptr< Aspose::Cells::Systems::String > formula)=0
	Add a calculated item to the pivot field. More...

virtual bool	GetShowCompact ()=0
	Gets compact mode. More...

virtual void	SetShowCompact (bool value)=0
	Sets compact mode. More...

Detailed Description

Represents a field in a PivotTable report.

Member Function Documentation

◆ AddCalculatedItem()

virtual void Aspose::Cells::Pivot::IPivotField::AddCalculatedItem	(	intrusive_ptr< Aspose::Cells::Systems::String >	name,
		intrusive_ptr< Aspose::Cells::Systems::String >	formula
	)

pure virtual

Add a calculated item to the pivot field.

Parameters

name	The item's name.
formula	The item's formula

Only supports to add calculated item to Row/Column field.

◆ Get_NumberFormat()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Pivot::IPivotField::Get_NumberFormat ( )

pure virtual

Represents the custom display format of numbers and dates.

◆ GetAutoShowCount()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetAutoShowCount ( )

pure virtual

Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

◆ GetAutoShowField()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetAutoShowField ( )

pure virtual

Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

◆ GetAutoSortField()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetAutoSortField ( )

pure virtual

Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.

◆ GetBaseFieldIndex()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetBaseFieldIndex ( )

pure virtual

Represents the base field for a custom calculation.

◆ GetBaseIndex()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetBaseIndex ( )

pure virtual

Represents the PivotField index in the base PivotFields.

◆ GetBaseItemIndex()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetBaseItemIndex ( )

pure virtual

Represents the item in the base field for a custom calculation. Valid only for data fields.

◆ GetBaseItemPosition()

virtual Aspose::Cells::Pivot::PivotItemPosition Aspose::Cells::Pivot::IPivotField::GetBaseItemPosition ( )

pure virtual

Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute.

PivotItemPosition

◆ GetCalculatedFieldFormula()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Pivot::IPivotField::GetCalculatedFieldFormula ( )

pure virtual

Get the formula string of the specified calculated field .

◆ GetCurrentPageItem()

virtual Aspose::Cells::Systems::Int16 Aspose::Cells::Pivot::IPivotField::GetCurrentPageItem ( )

pure virtual

Represents the current page item showing for the page field (valid only for page fields).

◆ GetDataDisplayFormat()

virtual Aspose::Cells::Pivot::PivotFieldDataDisplayFormat Aspose::Cells::Pivot::IPivotField::GetDataDisplayFormat ( )

pure virtual

Represents how to display the values contained in a data field.

PivotFieldDataDisplayFormat

◆ GetDisplayName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Pivot::IPivotField::GetDisplayName ( )

pure virtual

Represents the PivotField display name.

◆ GetDragToColumn()

virtual bool Aspose::Cells::Pivot::IPivotField::GetDragToColumn ( )

pure virtual

Indicates whether the specified field can be dragged to the column position. The default value is true.

◆ GetDragToData()

virtual bool Aspose::Cells::Pivot::IPivotField::GetDragToData ( )

pure virtual

Indicates whether the specified field can be dragged to the data position. The default value is true.

◆ GetDragToHide()

virtual bool Aspose::Cells::Pivot::IPivotField::GetDragToHide ( )

pure virtual

Indicates whether the specified field can be dragged to the hide position. The default value is true.

◆ GetDragToPage()

virtual bool Aspose::Cells::Pivot::IPivotField::GetDragToPage ( )

pure virtual

Indicates whether the specified field can be dragged to the page position. The default value is true.

◆ GetDragToRow()

virtual bool Aspose::Cells::Pivot::IPivotField::GetDragToRow ( )

pure virtual

Indicates whether the specified field can be dragged to the row position. The default value is true.

◆ GetFunction()

virtual Aspose::Cells::ConsolidationFunction Aspose::Cells::Pivot::IPivotField::GetFunction ( )

pure virtual

Represents the function used to summarize the PivotTable data field.

◆ GetInsertBlankRow()

virtual bool Aspose::Cells::Pivot::IPivotField::GetInsertBlankRow ( )

pure virtual

Indicates whether inserting blank line after each item.

◆ GetIPivotFilterByType()

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotFilter> Aspose::Cells::Pivot::IPivotField::GetIPivotFilterByType ( Aspose::Cells::Pivot::PivotFilterType type )

pure virtual

Gets the pivot filter of the pivot field by type

◆ GetIPivotItems()

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotItemCollection> Aspose::Cells::Pivot::IPivotField::GetIPivotItems ( )

pure virtual

Gets the pivot items of the pivot field

◆ GetIRange()

virtual intrusive_ptr<Aspose::Cells::Pivot::ISxRng> Aspose::Cells::Pivot::IPivotField::GetIRange ( )

pure virtual

Gets the group range of the pivot field

◆ GetItemCount()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetItemCount ( )

pure virtual

Gets the base item count of this pivot field.

◆ GetItems()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::Systems::String*> > Aspose::Cells::Pivot::IPivotField::GetItems ( )

pure virtual

Get all base items;

◆ GetName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Pivot::IPivotField::GetName ( )

pure virtual

Represents the PivotField name.

◆ GetNonAutoSortDefault()

virtual bool Aspose::Cells::Pivot::IPivotField::GetNonAutoSortDefault ( )

pure virtual

Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.

◆ GetNumber()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetNumber ( )

pure virtual

Represents the built-in display format of numbers and dates.

◆ GetOriginalItems()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::Systems::String*> > Aspose::Cells::Pivot::IPivotField::GetOriginalItems ( )

pure virtual

Get the original base items;

◆ GetPivotFilters()

virtual intrusive_ptr<Aspose::Cells::Systems::Collections::ArrayList> Aspose::Cells::Pivot::IPivotField::GetPivotFilters ( )

pure virtual

Gets the pivot filters of the pivot field

◆ GetPosition()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotField::GetPosition ( )

pure virtual

Represents the PivotField index in the PivotFields.

◆ GetShowAllItems()

virtual bool Aspose::Cells::Pivot::IPivotField::GetShowAllItems ( )

pure virtual

Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.

◆ GetShowCompact()

virtual bool Aspose::Cells::Pivot::IPivotField::GetShowCompact ( )

pure virtual

Gets compact mode.

◆ GetShowInOutlineForm()

virtual bool Aspose::Cells::Pivot::IPivotField::GetShowInOutlineForm ( )

pure virtual

Indicates whether layout this field in outline form on the Pivot Table view

◆ GetShowSubtotalAtTop()

virtual bool Aspose::Cells::Pivot::IPivotField::GetShowSubtotalAtTop ( )

pure virtual

when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom

◆ GetSubtotals()

virtual bool Aspose::Cells::Pivot::IPivotField::GetSubtotals ( Aspose::Cells::Pivot::PivotFieldSubtotalType subtotalType )

pure virtual

Gets whether the specified field shows that subtotals.

Parameters

subtotalType subtotals type.

Returns: whether the specified field shows that subtotals.

◆ HideDetail()

virtual void Aspose::Cells::Pivot::IPivotField::HideDetail ( bool isHiddenDetail )

pure virtual

Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.

Parameters

isHiddenDetail whether the PivotItems is hidden

◆ HideItem() [1/2]

virtual void Aspose::Cells::Pivot::IPivotField::HideItem	(	Aspose::Cells::Systems::Int32	index,
		bool	isHidden
	)

pure virtual

Sets whether the specific PivotItem in a data field is hidden.

Parameters

index	the index of the pivotItem in the pivotField.
isHidden	whether the specific PivotItem is hidden

◆ HideItem() [2/2]

virtual void Aspose::Cells::Pivot::IPivotField::HideItem	(	intrusive_ptr< Aspose::Cells::Systems::String >	itemValue,
		bool	isHidden
	)

pure virtual

Sets whether the specific PivotItem in a data field is hidden.

Parameters

itemValue	the value of the pivotItem in the pivotField.
isHidden	whether the specific PivotItem is hidden

◆ HideItemDetail()

virtual void Aspose::Cells::Pivot::IPivotField::HideItemDetail	(	Aspose::Cells::Systems::Int32	index,
		bool	isHiddenDetail
	)

pure virtual

Sets whether the specific PivotItem in a pivot field is hidden detail.

Parameters

index	the index of the pivotItem in the pivotField.
isHiddenDetail	whether the specific PivotItem is hidden

◆ InitPivotItems()

virtual void Aspose::Cells::Pivot::IPivotField::InitPivotItems ( )

pure virtual

Init the pivot items of the pivot field

◆ IsAscendShow()

virtual bool Aspose::Cells::Pivot::IPivotField::IsAscendShow ( )

pure virtual

Indicates whether the specified PivotTable field is autoshown ascending.

◆ IsAscendSort()

virtual bool Aspose::Cells::Pivot::IPivotField::IsAscendSort ( )

pure virtual

Indicates whether the specified PivotTable field is autosorted ascending.

◆ IsAutoShow()

virtual bool Aspose::Cells::Pivot::IPivotField::IsAutoShow ( )

pure virtual

Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.

◆ IsAutoSort()

virtual bool Aspose::Cells::Pivot::IPivotField::IsAutoSort ( )

pure virtual

Indicates whether the specified PivotTable field is automatically sorted.

◆ IsAutoSubtotals()

virtual bool Aspose::Cells::Pivot::IPivotField::IsAutoSubtotals ( )

pure virtual

Indicates whether the specified field shows automatic subtotals. Default is true.

◆ IsCalculatedField()

virtual bool Aspose::Cells::Pivot::IPivotField::IsCalculatedField ( )

pure virtual

Indicates whether the specified PivotTable field is calculated field.

◆ IsHiddenItem()

virtual bool Aspose::Cells::Pivot::IPivotField::IsHiddenItem ( Aspose::Cells::Systems::Int32 index )

pure virtual

Indicates whether the specific PivotItem is hidden.

Parameters

index the index of the pivotItem in the pivotField.

Returns: whether the specific PivotItem is hidden

◆ IsHiddenItemDetail()

virtual bool Aspose::Cells::Pivot::IPivotField::IsHiddenItemDetail ( Aspose::Cells::Systems::Int32 index )

pure virtual

Indicates whether the specific PivotItem is hidden detail.

Parameters

index the index of the pivotItem in the pivotField.

Returns: whether the specific PivotItem is hidden detail

◆ IsIncludeNewItemsInFilter()

virtual bool Aspose::Cells::Pivot::IPivotField::IsIncludeNewItemsInFilter ( )

pure virtual

indicates whether the field can include new items in manual filter The default value is false.

◆ IsInsertPageBreaksBetweenItems()

virtual bool Aspose::Cells::Pivot::IPivotField::IsInsertPageBreaksBetweenItems ( )

pure virtual

indicates whether the field can insert page breaks between items insert page break after each item The default value is false.

◆ IsMultipleItemSelectionAllowed()

virtual bool Aspose::Cells::Pivot::IPivotField::IsMultipleItemSelectionAllowed ( )

pure virtual

indicates whether the field can have multiple items selected in the page field The default value is false.

◆ IsRepeatItemLabels()

virtual bool Aspose::Cells::Pivot::IPivotField::IsRepeatItemLabels ( )

pure virtual

indicates whether the field can repeat items labels The default value is false.

◆ SetAscendShow()

virtual void Aspose::Cells::Pivot::IPivotField::SetAscendShow ( bool value )

pure virtual

Indicates whether the specified PivotTable field is autoshown ascending.

◆ SetAscendSort()

virtual void Aspose::Cells::Pivot::IPivotField::SetAscendSort ( bool value )

pure virtual

Indicates whether the specified PivotTable field is autosorted ascending.

◆ SetAutoShow()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoShow ( bool value )

pure virtual

Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.

◆ SetAutoShowCount()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoShowCount ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

◆ SetAutoShowField()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoShowField ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

◆ SetAutoSort()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoSort ( bool value )

pure virtual

Indicates whether the specified PivotTable field is automatically sorted.

◆ SetAutoSortField()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoSortField ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.

◆ SetAutoSubtotals()

virtual void Aspose::Cells::Pivot::IPivotField::SetAutoSubtotals ( bool value )

pure virtual

Indicates whether the specified field shows automatic subtotals. Default is true.

◆ SetBaseFieldIndex()

virtual void Aspose::Cells::Pivot::IPivotField::SetBaseFieldIndex ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the base field for a custom calculation.

◆ SetBaseIndex()

virtual void Aspose::Cells::Pivot::IPivotField::SetBaseIndex ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the PivotField index in the base PivotFields.

◆ SetBaseItemIndex()

virtual void Aspose::Cells::Pivot::IPivotField::SetBaseItemIndex ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the item in the base field for a custom calculation. Valid only for data fields.

◆ SetBaseItemPosition()

virtual void Aspose::Cells::Pivot::IPivotField::SetBaseItemPosition ( Aspose::Cells::Pivot::PivotItemPosition value )

pure virtual

Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute.

PivotItemPosition

◆ SetCurrentPageItem()

virtual void Aspose::Cells::Pivot::IPivotField::SetCurrentPageItem ( Aspose::Cells::Systems::Int16 value )

pure virtual

Represents the current page item showing for the page field (valid only for page fields).

◆ SetDataDisplayFormat()

virtual void Aspose::Cells::Pivot::IPivotField::SetDataDisplayFormat ( Aspose::Cells::Pivot::PivotFieldDataDisplayFormat value )

pure virtual

Represents how to display the values contained in a data field.

PivotFieldDataDisplayFormat

◆ SetDisplayName()

virtual void Aspose::Cells::Pivot::IPivotField::SetDisplayName ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Represents the PivotField display name.

◆ SetDragToColumn()

virtual void Aspose::Cells::Pivot::IPivotField::SetDragToColumn ( bool value )

pure virtual

Indicates whether the specified field can be dragged to the column position. The default value is true.

◆ SetDragToData()

virtual void Aspose::Cells::Pivot::IPivotField::SetDragToData ( bool value )

pure virtual

Indicates whether the specified field can be dragged to the data position. The default value is true.

◆ SetDragToHide()

virtual void Aspose::Cells::Pivot::IPivotField::SetDragToHide ( bool value )

pure virtual

Indicates whether the specified field can be dragged to the hide position. The default value is true.

◆ SetDragToPage()

virtual void Aspose::Cells::Pivot::IPivotField::SetDragToPage ( bool value )

pure virtual

Indicates whether the specified field can be dragged to the page position. The default value is true.

◆ SetDragToRow()

virtual void Aspose::Cells::Pivot::IPivotField::SetDragToRow ( bool value )

pure virtual

Indicates whether the specified field can be dragged to the row position. The default value is true.

◆ SetFunction()

virtual void Aspose::Cells::Pivot::IPivotField::SetFunction ( Aspose::Cells::ConsolidationFunction value )

pure virtual

Represents the function used to summarize the PivotTable data field.

◆ SetIncludeNewItemsInFilter()

virtual void Aspose::Cells::Pivot::IPivotField::SetIncludeNewItemsInFilter ( bool value )

pure virtual

indicates whether the field can include new items in manual filter The default value is false.

◆ SetInsertBlankRow()

virtual void Aspose::Cells::Pivot::IPivotField::SetInsertBlankRow ( bool value )

pure virtual

Indicates whether inserting blank line after each item.

◆ SetInsertPageBreaksBetweenItems()

virtual void Aspose::Cells::Pivot::IPivotField::SetInsertPageBreaksBetweenItems ( bool value )

pure virtual

indicates whether the field can insert page breaks between items insert page break after each item The default value is false.

◆ SetMultipleItemSelectionAllowed()

virtual void Aspose::Cells::Pivot::IPivotField::SetMultipleItemSelectionAllowed ( bool value )

pure virtual

indicates whether the field can have multiple items selected in the page field The default value is false.

◆ SetNonAutoSortDefault()

virtual void Aspose::Cells::Pivot::IPivotField::SetNonAutoSortDefault ( bool value )

pure virtual

Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.

◆ SetNumber()

virtual void Aspose::Cells::Pivot::IPivotField::SetNumber ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the built-in display format of numbers and dates.

◆ SetNumberFormat()

virtual void Aspose::Cells::Pivot::IPivotField::SetNumberFormat ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Represents the custom display format of numbers and dates.

◆ SetRepeatItemLabels()

virtual void Aspose::Cells::Pivot::IPivotField::SetRepeatItemLabels ( bool value )

pure virtual

indicates whether the field can repeat items labels The default value is false.

◆ SetShowAllItems()

virtual void Aspose::Cells::Pivot::IPivotField::SetShowAllItems ( bool value )

pure virtual

Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.

◆ SetShowCompact()

virtual void Aspose::Cells::Pivot::IPivotField::SetShowCompact ( bool value )

pure virtual

Sets compact mode.

◆ SetShowInOutlineForm()

virtual void Aspose::Cells::Pivot::IPivotField::SetShowInOutlineForm ( bool value )

pure virtual

Indicates whether layout this field in outline form on the Pivot Table view

◆ SetShowSubtotalAtTop()

virtual void Aspose::Cells::Pivot::IPivotField::SetShowSubtotalAtTop ( bool value )

pure virtual

when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom

◆ SetSubtotals()

virtual void Aspose::Cells::Pivot::IPivotField::SetSubtotals	(	Aspose::Cells::Pivot::PivotFieldSubtotalType	subtotalType,
		bool	shown
	)

pure virtual

Sets whether the specified field shows that subtotals.

Parameters

subtotalType	subtotals type.
shown	whether the specified field shows that subtotals.

PivotFieldSubtotalType

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddCalculatedItem()

◆ Get_NumberFormat()

◆ GetAutoShowCount()

◆ GetAutoShowField()

◆ GetAutoSortField()

◆ GetBaseFieldIndex()

◆ GetBaseIndex()

◆ GetBaseItemIndex()

◆ GetBaseItemPosition()

◆ GetCalculatedFieldFormula()

◆ GetCurrentPageItem()

◆ GetDataDisplayFormat()

◆ GetDisplayName()

◆ GetDragToColumn()

◆ GetDragToData()

◆ GetDragToHide()

◆ GetDragToPage()

◆ GetDragToRow()

◆ GetFunction()

◆ GetInsertBlankRow()

◆ GetIPivotFilterByType()

◆ GetIPivotItems()

◆ GetIRange()

◆ GetItemCount()

◆ GetItems()

◆ GetName()

◆ GetNonAutoSortDefault()

◆ GetNumber()

◆ GetOriginalItems()

◆ GetPivotFilters()

◆ GetPosition()

◆ GetShowAllItems()

◆ GetShowCompact()

◆ GetShowInOutlineForm()

◆ GetShowSubtotalAtTop()

◆ GetSubtotals()

◆ HideDetail()

◆ HideItem() [1/2]

◆ HideItem() [2/2]

◆ HideItemDetail()

◆ InitPivotItems()

◆ IsAscendShow()

◆ IsAscendSort()

◆ IsAutoShow()

◆ IsAutoSort()

◆ IsAutoSubtotals()

◆ IsCalculatedField()

◆ IsHiddenItem()

◆ IsHiddenItemDetail()

◆ IsIncludeNewItemsInFilter()

◆ IsInsertPageBreaksBetweenItems()

◆ IsMultipleItemSelectionAllowed()

◆ IsRepeatItemLabels()

◆ SetAscendShow()

◆ SetAscendSort()

◆ SetAutoShow()

◆ SetAutoShowCount()

◆ SetAutoShowField()

◆ SetAutoSort()

◆ SetAutoSortField()

◆ SetAutoSubtotals()

◆ SetBaseFieldIndex()

◆ SetBaseIndex()

◆ SetBaseItemIndex()

◆ SetBaseItemPosition()

◆ SetCurrentPageItem()

◆ SetDataDisplayFormat()

◆ SetDisplayName()

◆ SetDragToColumn()

◆ SetDragToData()

◆ SetDragToHide()

◆ SetDragToPage()

◆ SetDragToRow()

◆ SetFunction()

◆ SetIncludeNewItemsInFilter()

◆ SetInsertBlankRow()

◆ SetInsertPageBreaksBetweenItems()