IUIX_CmdBar Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar Interface}}
 
{{#customTitle:IUIX_CmdBar Interface}}
 +
{{#parentPage:PXV:UIX_Interfaces|IUIX_CmdBar|interface}}
 +
{{ToReview}}
  
−
The interface of object of PDF-XChange Editor SDK.
+
This interface is used to manage [[PXV:IUIX_CmdItemBox|command boxes]] in the current command bar. Also, it allows changing the command bar's properties.
  
 
IUIX_CmdBar extends [[PXV:IUIX_ObjImpl|IUIX_ObjImpl]] interface.
 
IUIX_CmdBar extends [[PXV:IUIX_ObjImpl|IUIX_ObjImpl]] interface.
  
 
== Methods ==
 
== Methods ==
−
{| class="wikitable sortable collapsible" style="width: 100%"
+
{| class="wikitable methods"
−
|-
+
−
! style="text-align: left" scope="col" width="15%" | Method
+
−
! style="text-align: left" scope="col" class="unsortable" | Description
+
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_Clear|Clear]]
 
| [[PXV:IUIX_CmdBar_Clear|Clear]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatFindFirstItemByCmdName|FlatFindFirstItemByCmdName]]
 +
| [[PXV:IUIX_CmdBar_Hide|Hide]]
 +
| [[PXV:IUIX_CmdBar_MakeFloating|MakeFloating]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_DeleteBoxes|DeleteBoxes]]
 
| [[PXV:IUIX_CmdBar_DeleteBoxes|DeleteBoxes]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatGetItem|FlatGetItem]]
 +
| [[PXV:IUIX_CmdBar_Highlight|Highlight]]
 +
| [[PXV:IUIX_CmdBar_MakeFloating2|MakeFloating2]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_DeleteItemsByCmd|DeleteItemsByCmd]]
 
| [[PXV:IUIX_CmdBar_DeleteItemsByCmd|DeleteItemsByCmd]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatGetItemsCount|FlatGetItemsCount]]
 +
| [[PXV:IUIX_CmdBar_HitTest|HitTest]]
 +
| [[PXV:IUIX_CmdBar_Minimize|Minimize]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_Expand|Expand]]
 
| [[PXV:IUIX_CmdBar_Expand|Expand]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatInsertItem|FlatInsertItem]]
 +
| [[PXV:IUIX_CmdBar_InsertItem|InsertItem]]
 +
| [[PXV:IUIX_CmdBar_MoveBoxes|MoveBoxes]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_FindFirstItemByCmdID|FindFirstItemByCmdID]]
 
| [[PXV:IUIX_CmdBar_FindFirstItemByCmdID|FindFirstItemByCmdID]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatInsertItem2|FlatInsertItem2]]
 +
| [[PXV:IUIX_CmdBar_InsertItem2|InsertItem2]]
 +
| [[PXV:IUIX_CmdBar_Redraw|Redraw]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_FindFirstItemByCmdName|FindFirstItemByCmdName]]
 
| [[PXV:IUIX_CmdBar_FindFirstItemByCmdName|FindFirstItemByCmdName]]
−
| ...
+
| [[PXV:IUIX_CmdBar_FlatInsertSeparator|FlatInsertSeparator]]
 +
| [[PXV:IUIX_CmdBar_InsertNewBox|InsertNewBox]]
 +
| [[PXV:IUIX_CmdBar_Show|Show]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_FindItemByCtl|FindItemByCtl]]
 
| [[PXV:IUIX_CmdBar_FindItemByCtl|FindItemByCtl]]
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatDeleteItem|FlatDeleteItem]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatFindFirstItemByCmdID|FlatFindFirstItemByCmdID]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatFindFirstItemByCmdName|FlatFindFirstItemByCmdName]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatGetItem|FlatGetItem]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatGetItemsCount|FlatGetItemsCount]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatInsertItem|FlatInsertItem]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatInsertItem2|FlatInsertItem2]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_FlatInsertSeparator|FlatInsertSeparator]]
 
−
| ...
 
−
|-
 
 
| [[PXV:IUIX_CmdBar_FlatItemIsSeparator|FlatItemIsSeparator]]
 
| [[PXV:IUIX_CmdBar_FlatItemIsSeparator|FlatItemIsSeparator]]
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Hide|Hide]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Highlight|Highlight]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_InsertItem|InsertItem]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_InsertItem2|InsertItem2]]
 
−
| ...
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_InsertNewBox|InsertNewBox]]
 
−
| ...
 
−
|-
 
 
| [[PXV:IUIX_CmdBar_InsertNewBox2|InsertNewBox2]]
 
| [[PXV:IUIX_CmdBar_InsertNewBox2|InsertNewBox2]]
−
| ...
+
| [[PXV:IUIX_CmdBar_UnLockUpdates|UnLockUpdates]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_FlatDeleteItem|FlatDeleteItem]]
 +
| [[PXV:IUIX_CmdBar_GetIdealSize|GetIdealSize]]
 
| [[PXV:IUIX_CmdBar_InsertSeparator|InsertSeparator]]
 
| [[PXV:IUIX_CmdBar_InsertSeparator|InsertSeparator]]
−
| ...
+
| [[PXV:IUIX_CmdBar_Update|Update]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_FlatFindFirstItemByCmdID|FlatFindFirstItemByCmdID]]
 +
| [[PXV:IUIX_CmdBar_GetItemWithPopupDisplayed|GetItemWithPopupDisplayed]]
 
| [[PXV:IUIX_CmdBar_LockUpdates|LockUpdates]]
 
| [[PXV:IUIX_CmdBar_LockUpdates|LockUpdates]]
−
| ...
+
| [[PXV:IUIX_CmdBar_UpdateItems|UpdateItems]]
−
|-
+
−
| [[PXV:IUIX_CmdBar_MakeFloating|MakeFloating]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_MakeFloating2|MakeFloating2]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_Minimize|Minimize]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_MoveBoxes|MoveBoxes]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_Redraw|Redraw]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_Show|Show]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_UnLockUpdates|UnLockUpdates]]
+
−
| ...
+
−
|-
+
−
| [[PXV:IUIX_CmdBar_Update|Update]]
+
−
| ...
+
 
|}
 
|}
  
 
== Properties ==
 
== Properties ==
−
{| style="width: 100%" class="wikitable sortable collapsible"
+
{| class="wikitable properties"
−
|-
+
−
! style="text-align: left" scope="col" width="15%" | Property
+
−
! style="text-align: center" scope="col" width="5%" | Access Type
+
−
! style="text-align: left" scope="col"  class="unsortable" | Description
+
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar__NewEnum|_NewEnum]]
 
| [[PXV:IUIX_CmdBar__NewEnum|_NewEnum]]
−
| style="text-align: center" | R
+
| [[PXV:IUIX_CmdBar_HasChevron|HasChevron]]
−
| .
+
| [[PXV:IUIX_CmdBar_IsPopupBox|IsPopupBox]]
 +
| [[PXV:IUIX_CmdBar_Line|Line]]
 
|-
 
|-
 
| [[PXV:IUIX_CmdBar_ActualSize|ActualSize]]
 
| [[PXV:IUIX_CmdBar_ActualSize|ActualSize]]
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_BorderStyle|BorderStyle]]
 
−
| style="text-align: center" | R/W
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Count|Count]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Font|Font]]
 
−
| style="text-align: center" | R/W
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_HasChevron|HasChevron]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
 
| [[PXV:IUIX_CmdBar_Icon|Icon]]
 
| [[PXV:IUIX_CmdBar_Icon|Icon]]
−
| style="text-align: center" | R/W
+
| [[PXV:IUIX_CmdBar_IsPopupMenu|IsPopupMenu]]
−
| .
+
| [[PXV:IUIX_CmdBar_Owner|Owner]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_AppMenuContainer|AppMenuContainer]]
 
| [[PXV:IUIX_CmdBar_ID|ID]]
 
| [[PXV:IUIX_CmdBar_ID|ID]]
−
| style="text-align: center" | R
+
| [[PXV:IUIX_CmdBar_IsSpecial|IsSpecial]]
−
| .
+
| [[PXV:IUIX_CmdBar_Parent|Parent]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_BorderStyle|BorderStyle]]
 
| [[PXV:IUIX_CmdBar_IsFloating|IsFloating]]
 
| [[PXV:IUIX_CmdBar_IsFloating|IsFloating]]
−
| style="text-align: center" | R
+
| [[PXV:IUIX_CmdBar_IsTemp|IsTemp]]
−
| .
+
| [[PXV:IUIX_CmdBar_Size|Size]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_Count|Count]]
 
| [[PXV:IUIX_CmdBar_IsHidden|IsHidden]]
 
| [[PXV:IUIX_CmdBar_IsHidden|IsHidden]]
−
| style="text-align: center" | R
+
| [[PXV:IUIX_CmdBar_IsVert|IsVert]]
−
| .
+
| [[PXV:IUIX_CmdBar_Title|Title]]
 
|-
 
|-
 +
| [[PXV:IUIX_CmdBar_Font|Font]]
 
| [[PXV:IUIX_CmdBar_IsMinimized|IsMinimized]]
 
| [[PXV:IUIX_CmdBar_IsMinimized|IsMinimized]]
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_IsPopupBox|IsPopupBox]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_IsPopupMenu|IsPopupMenu]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_IsVert|IsVert]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
 
| [[PXV:IUIX_CmdBar_Item|Item]]
 
| [[PXV:IUIX_CmdBar_Item|Item]]
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Line|Line]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Owner|Owner]]
 
−
| style="text-align: center" | R/W
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Parent|Parent]]
 
−
| style="text-align: center" | R
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Size|Size]]
 
−
| style="text-align: center" | R/W
 
−
| .
 
−
|-
 
−
| [[PXV:IUIX_CmdBar_Title|Title]]
 
−
| style="text-align: center" | R/W
 
−
| .
 
−
|-
 
 
| [[PXV:IUIX_CmdBar_UpdatesLocked|UpdatesLocked]]
 
| [[PXV:IUIX_CmdBar_UpdatesLocked|UpdatesLocked]]
−
| style="text-align: center" | R
 
−
| .
 
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IUIX_CmdHandler_OnCreateNewCtl|IUIX_CmdHandler::OnCreateNewCtl]], [[PXV:IUIX_CmdItem_Bar|IUIX_CmdItem::Bar]], [[PXV:IUIX_CmdLine_GetBarIndex|IUIX_CmdLine::GetBarIndex]], [[PXV:IUIX_CmdLine_InsertBar|IUIX_CmdLine::InsertBar]], [[PXV:IUIX_CmdLine_Item|IUIX_CmdLine::Item]], [[PXV:IUIX_CmdPane_InsertBar|IUIX_CmdPane::InsertBar]], [[PXV:IUIX_CmdPane_QABar|IUIX_CmdPane::QABar]], [[PXV:IUIX_CmdPane_QLBar|IUIX_CmdPane::QLBar]], [[PXV:IUIX_CmdRibbonTabs_DeleteBar|IUIX_CmdRibbonTabs::DeleteBar]], [[PXV:IUIX_CmdRibbonTab_Find|IUIX_CmdRibbonTab::Find]], [[PXV:IUIX_CmdRibbonTab_Insert|IUIX_CmdRibbonTab::Insert]], [[PXV:IUIX_CmdRibbonTab_Item|IUIX_CmdRibbonTab::Item]], [[PXV:IUIX_Inst_CreateCmdBar|IUIX_Inst::CreateCmdBar]], [[PXV:IUIX_ScrollContainer_CmdBar|IUIX_ScrollContainer::CmdBar]], [[PXV:IUIX_PropHost_OnShowProps|IUIX_PropHost::OnShowProps]], [[PXV:IPXV_MainView_MenuBar|IPXV_MainView::MenuBar]], [[PXV:IPXV_MainView_PropsBar|IPXV_MainView::PropsBar]], [[PXV:IPXV_View_CmdBar|IPXV_View::CmdBar]], [[PXV:IPXV_View_CmdBar2|IPXV_View::CmdBar2]]

Latest revision as of 23:42, 19 May 2018

UI Layer > Interfaces > IUIX_CmdBar Interface


This interface is used to manage command boxes in the current command bar. Also, it allows changing the command bar's properties.

IUIX_CmdBar extends IUIX_ObjImpl interface.

Methods

Clear FlatFindFirstItemByCmdName Hide MakeFloating
DeleteBoxes FlatGetItem Highlight MakeFloating2
DeleteItemsByCmd FlatGetItemsCount HitTest Minimize
Expand FlatInsertItem InsertItem MoveBoxes
FindFirstItemByCmdID FlatInsertItem2 InsertItem2 Redraw
FindFirstItemByCmdName FlatInsertSeparator InsertNewBox Show
FindItemByCtl FlatItemIsSeparator InsertNewBox2 UnLockUpdates
FlatDeleteItem GetIdealSize InsertSeparator Update
FlatFindFirstItemByCmdID GetItemWithPopupDisplayed LockUpdates UpdateItems

Properties

_NewEnum HasChevron IsPopupBox Line
ActualSize Icon IsPopupMenu Owner
AppMenuContainer ID IsSpecial Parent
BorderStyle IsFloating IsTemp Size
Count IsHidden IsVert Title
Font IsMinimized Item UpdatesLocked

See Also

IUIX_CmdHandler::OnCreateNewCtl, IUIX_CmdItem::Bar, IUIX_CmdLine::GetBarIndex, IUIX_CmdLine::InsertBar, IUIX_CmdLine::Item, IUIX_CmdPane::InsertBar, IUIX_CmdPane::QABar, IUIX_CmdPane::QLBar, IUIX_CmdRibbonTabs::DeleteBar, IUIX_CmdRibbonTab::Find, IUIX_CmdRibbonTab::Insert, IUIX_CmdRibbonTab::Item, IUIX_Inst::CreateCmdBar, IUIX_ScrollContainer::CmdBar, IUIX_PropHost::OnShowProps, IPXV_MainView::MenuBar, IPXV_MainView::PropsBar, IPXV_View::CmdBar, IPXV_View::CmdBar2

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IUIX_CmdBar&oldid=51303"