Facade Namespace Reference

Classes
class	IAdvTextOptionsFacade
class	IAnimationFacade
class	IAppearanceItemFacade
class	IArrangeFacade
class	IArticleFacade
class	IBarcodeFacade
class	IBookmarkFacade
class	ICellStylesFacade
class	IColorGroupFacade
class	IConditionalTextFacade
class	IContentDropperFacade
class	IDigitalPublishingFacade
class	IDigitalPublishingRasterizerFacade
class	IDigitalPublishingVectorExportFacade
class	IDigitalPublishingFacade2
class	IDigitalPublishingFacade3
class	IDynamicEventTimingFacade
class	IDynamicTargetsFacade
class	IEndnoteFacade
class	IFlowFacade
class	IFrameContentFacade
class	IGeometryFacade
class	IGlyphFacade
class	IGuideFacade
class	IGuidePreferencesFacade
class	IHTMLPageItemFacade
class	IHyperlinkFacade
class	IHyperlinkUIFacade
class	IImageFacade
class	IImportExportFacade
class	IInteractivePDF_ExportFacade
class	IItemThumbnailFacade
class	ILayerFacade
class	ILinkFacade
class	ILiveEditFacade
class	IMotionFacade
class	IObjectStylesFacade
class	IPageItemLockFacade
class	IPageItemNameFacade
class	IPageItemScrapFacade
class	IPageItemVisibilityFacade
class	IPageTransitionFacade
class	IPDFStructureOrderPrefFacade
class	IPreflightFacade
class	IRecentFileListFacade
class	ISharedContentFacade
class	ISpreadFacade
class	IStoryViewTableFacade
class	IStyleMappingFacade
class	ITableStylesFacade
class	ITaskMonitorFacade
class	ITextFragmentLinkFacade
class	ITextFrameFacade
class	ITextPreferencesFacade
class	ITextStylesFacade
class	ITextWrapFacade
class	ITransformFacade
class	IUserInterfacePreferencesFacade
class	IWorkgroupFacade
class	IWorkgroupStoryFacade
class	IXMLRuleActionFacade

Enumerations
enum	DynamicAutoFlowKind { kAtEndOfStory = 0, kAtEndOfSection, kAtEndOfDocument }

Functions
bool	IsLiveEditAvailable ()

Detailed Description

IDigitalPublishingFacade defines the interface for this plug-ins facade. A Facade is a functional API layer that sits on top of commands and other complicated model operatoins. Script providers and selection suites often have to do the same thing. Putting command and other model specific code into a facade provides code reuse.

IFrameContentFacade interface

Provide a suite for convert between pageitem frame and its contents

High-level facade interface for glyph-related queries.

See Also

IGlyphUtils

A high level API for dealing with guide options/prefs. Please use the IGuidePreferencesFacade directly via the UtilsBoss if possible, see Utils.h: i.e. Utils<Facade::IGuidePreferencesFacade>()->ShowSmartGuides(...);

Author

Dave Stephens

Interface used to manage import and export.

See Also

IPlaceBehavior

IPlaceGun

Suite interface to manipulate document-wide layers

See Also

kDocumentLayerBoss

Interface used to manage linked resources and links. When possible, interaction with a linked resource or link should be performed via the methods in this interface rather than directly with ILinkResource or ILink.

See Also

ILink

ILinkResource

ILinkObject

UID

UIDRef

URI

Lock and Unlock page item Facade

Facade to get/set page item names.

Show and Hide page item Facade

Interface used to maintain a list of the most recently used document files.

See Also

IDFile

Interface used to manage shared content linked resources and links. When possible, interaction with a shared content linked resource or link should be performed via the methods in this interface.

See Also

ILink

ILinkResource

ILinkObject

UID

UIDRef

URI

A high level API for tables in the story editor running InDesign or story and galley views running InCopy. Facade is for features unique to story views such as collapsing the display of a table down to a icon. Please use the IStoryViewTableFacade directly via the UtilsBoss if possible, see Utils.h: i.e. Utils<Facade::IStoryViewTableFacade>()->GetIsTableCollapsed(...);

Author

Kevin Van Wiel

Interface used to manage style mappings data on document, app or story. When possible, interaction with the style mapping data should be performed via the methods in this interface.

See Also

IStyleMappings

UID

UIDRef

Utility functions for working with table styles. To use these functions use the Utils boss:
Utils<Facade::ITableStylesFacade>()->CreateTableStyle(...);

Interface used to manage background tasks and access their status.

See Also

TaskInfo

Experimental interface - will be modified/documented in future. Interface used to manage linked resources and links. When possible, interaction with a linked resource or link should be performed via the methods in this interface rather than directly with ILinkResource or ILink.

See Also

ILink

ILinkResource

ILinkObject

UID

UIDRef

URI

A high level API for dealing with text options/prefs. Please use the ITextPreferencesFacade directly via the UtilsBoss if possible, see Utils.h: i.e. Utils<Facade::ITextPreferencesFacade>()->SetTextToolConvertsFrames( ... ) ;

Author

Dave Stephens

This facade is used for manipulating Text (paragraph and character) styles and groups. Please use the ITextStylesFacade directly via the UtilsBoss, see Utils.h. e.g.Utils<Facade::ITextStylesFacade>()->MethodName( ... );

Interface used to set new user interface preferences.

See Also

IUserInterfacePreferences

The IWorkgroupFacade provides high-level access to the public AMSP interfaces. Suggested usage:

Utils<Facade::IWorkgroupFacade>()->method( params,... );

The IWorkgroupStoryFacade provides high-level access to the public AMSP interfaces for LiveEdit stories. Suggested usage:

Utils<Facade::IWorkgroupStoryFacade>()->method( params,... );

Note that "storyRef" in method definitions refers to the UIDRef of the story page item, not to the UIDRef of the corresponding link boss.

Exposes methods to do actions on XMLElements that are typically done with the XML Rules functionality

Enumeration Type Documentation

enum Facade::DynamicAutoFlowKind

Enumerator
kAtEndOfSection	auto-add pages at end of story
kAtEndOfDocument	auto-add pages at end of section. auto-add pages at end of document.

Function Documentation

bool Facade::IsLiveEditAvailable ( )

inline

Tests if the LiveEdit feature is available.