C# Class WorkbookPublishSettings, TabMigrate

Show file Open project: tableau/TabMigrate Class Usage Examples

Public Properties

Property Type Description
OwnerName string
ShowTabs bool

Public Methods

Method Description
WorkbookPublishSettings ( bool showTabs, string ownerName ) : System

Constructor

Private Methods

Method Description
CreateSettingsFile ( SiteWorkbook, wb, string localWorkbookPath, KeyedLookup userLookups ) : void

Save Workbook metadata in a XML file along-side the workbook file

GenerateDefaultSettings ( ) : WorkbookPublishSettings,

Default settings to use if no settings file is present

GetSettingsForSavedWorkbook ( string workbookWithPath ) : WorkbookPublishSettings,

Look up any saved settings we have associated with a workbook on our local file systemm

IsSettingsFile ( string filePath ) : bool

TRUE if the file is an internal settings file

ParseXml_GetOwnerName ( XmlDocument xmlDoc ) : string

Looks for the Owner Name information inside the XML document

ParseXml_GetShowSheetsAsTabs ( XmlDocument xmlDoc ) : bool

Looks for the ShowTabs information inside the XML document

PathForSettingsFile ( string workbookPath ) : string

Generates the path/filename of the Settings file that corresponds to the workbook path

helper_LookUpOwnerId ( string ownerId, KeyedLookup userLookups ) : string

Looks

Method Details

WorkbookPublishSettings() public method

Constructor
public WorkbookPublishSettings ( bool showTabs, string ownerName ) : System
showTabs bool
ownerName string
return System

Property Details

OwnerName public property

The name of the owner of the content (NULL if unknown)
public string OwnerName
return string

ShowTabs public property

TRUE: The published workbook should show tabs to navigate the sheets/dashboards/stories FALSE: No Tabs (each sheet/dashboard/story is accessed by its URL)
public bool ShowTabs
return bool