Service SubTotalDescriptor

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

:: com :: sun :: star :: sheet ::

service SubTotalDescriptor

Description: represents a description of how subtotals are created.; The descriptor contains properties and a collection of subtotal fields which control the behaviour of operation.

Developers Guide: Spreadsheets - Subtotals

Exported Interfaces - Summary
XSubTotalDescriptor	provides access to the collection of subtotal fields.
::com::sun::star::container::XEnumerationAccess	creates an enumeration of all sub total fields. (details)
::com::sun::star::container::XIndexAccess	provides access to the sub total fields in the collection via index.
::com::sun::star::beans::XPropertySet	procides access to the properties.

Properties' Summary
boolean InsertPageBreaks	specifies if page breaks are inserted after each group change.
boolean IsCaseSensitive	specifies if the case of letters is important when comparing entries.
boolean EnableUserSortList	specifies if a user defined sorting list is used.
long UserSortListIndex	specifies which user defined sorting list is used.
boolean BindFormatsToContent	specifies if cell formats are moved with the contents they belong to.
boolean EnableSort	specifies if the contents of the fields will be sorted to groups while performing a subtotal operation.
boolean SortAscending	specifies the sorting order if SubTotalDescriptor::EnableSort is set to true.
[ readonly ] long MaxFieldCount	returns the maximum number of subtotal fields the descriptor can hold.

Exported Interfaces - Details

XSubTotalDescriptor

Description provides access to the collection of subtotal fields.

::com::sun::star::container::XEnumerationAccess

Description creates an enumeration of all sub total fields. See also SubTotalFieldsEnumeration

::com::sun::star::container::XIndexAccess

Description provides access to the sub total fields in the collection via index.

::com::sun::star::beans::XPropertySet

Description procides access to the properties.

Properties' Details

InsertPageBreaks

boolean InsertPageBreaks; Description specifies if page breaks are inserted after each group change.

IsCaseSensitive

boolean IsCaseSensitive; Description specifies if the case of letters is important when comparing entries.

EnableUserSortList

boolean EnableUserSortList; Description specifies if a user defined sorting list is used.

UserSortListIndex

long UserSortListIndex; Description specifies which user defined sorting list is used. This property is only used if SubTotalDescriptor::EnableUserSortList is true.

BindFormatsToContent

boolean BindFormatsToContent; Description specifies if cell formats are moved with the contents they belong to.

EnableSort

boolean EnableSort; Description specifies if the contents of the fields will be sorted to groups while performing a subtotal operation.

SortAscending

boolean SortAscending; Description specifies the sorting order if SubTotalDescriptor::EnableSort is set to true.

MaxFieldCount

[ readonly ] long MaxFieldCount; Description returns the maximum number of subtotal fields the descriptor can hold. This read-only property indicates the maximum count of fields the current implementation supports.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous