NP Dynamic Libraries and Properties


<< NetPublish API ...
Back to Portfolio FAQ index
NP's paths and folders ... >>

NP Dynamic Libraries

These are used by NetPublish Assistant and are totally undocumented. Many of the object properties are collected from NP site XML configuration files via Template.get(property) calls. These XML properties are listed in the table further down the page..

Global Methods

urlEncode(value)
global_subfolder()
JSEscapeForSingleQuotes(s, level)
JSEscapeForDoubleQuotes(s, level)
htmlEncode(s)
encodeEscapeURI(s)

Template

Properties:
Template.dynamic
Template.preview
Template.windows

Methods:
Template.write(code)
Template.get(property)
Template.debugWrite(path,text)

Global

Properties:
Global.title
Global.logo
Global.header
Global.footer
Global.welcome
Global.homepage
Global.folder
Global.link
Global.siteRoot
Global.logoLink
Global.subFolder

Methods:
Global.debugGlobal(filePath)
Global.debugWriteKey(filePath, key)
Global.debugWriteProp(filePath, prop)

SearchField

Properties:
SearchField.name
SearchField.operators
SearchField.inputType
SearchField.presentation
SearchField.needsForm

Methods:
SearchField.outputSelectOptions()
SearchField.outputInputForm(attributes)

Search

Properties:
Search.selectedFields
Search.findAll
Search.stylesheet
Search.quickSearchCreate
Search.fields
Search.needsFormValue

Methods
Search.GetSearchOperatorUI(SearchOperator)
Search.needsForm()
Search.getFieldName()
Search_outputSelectOptions()
Search.outputInputForm(attributes)
Search.outputSearchOnForm()
Search.processFields(html)
Search.setQuickSearch()
Search.getPostCommand()
Search.debugSearch(filePath)
Search.debugWriteKey(filePath, key)
Search.debugWriteProp(filePath, prop)

Results

Properties:
Results.root
Results.rows
Results.cols
Results.stylesheet
Results.displayFields
Results.sort
Results.sortFieldName
Results.summarizeSearch
Results.collectionOptions
Results.clickAction
Results.thumbnailSize
Results.thumbnailWidthArg
Results.imgAttributes

Methods:
Results.outputFields(escapeStyle)
Results.outputFieldsWithSeparator(separator,escapeStyle)
Results.debugResults(filePath)
Results.debugWriteKey(filePath, key)
Results.debugWriteProp(filePath, prop)

Detail

Properties:
Detail.root
Detail.stylesheet
Detail.displayFields
Detail.collectionOptions
Detail.downloadOriginal
Detail.imageSource
Detail.imageSize
Detail.imageWidthArg
Detail.imgAttributes
Detail.clickAction
Detail.showOriginal

Methods:
Detail.outputFields(html)
Detail.getFieldName()
Detail.debugDetail(filePath)
Detail.debugWriteKey(filePath, key)
Detail.debugWriteProp(filePath, prop)

Collection

Properties:
Collection.rows
Collection.cols
Collection.stylesheet
Collection.displayFields
Collection.download
Collection.downloadZip
Collection.downloadSit
Collection.downloadOriginal
Collection.sort
Collection.sortFieldName
Collection.collectionOptions
Collection.downloadSource
Collection.clickAction
Collection.thumbnailSize
Collection.thumbnailWidthArg
Collection.imgAttributes

Methods:
Collection.outputFields(html)
Collection.outputFieldsWithSeparator(separator,escapeStyle)
Collection.getFieldName()
Collection.debugCollection(filePath)
Collection.debugWriteKey(filePath, key)
Collection.debugWriteProp(filePath, prop)

NP Site Properties

  Static Site Dynamic Site Search Gallery Results DetailsStatic DetailsWeb Collection
AllowDownloadOfCollection               Y
AllowSitFormat               Y
AllowZipFormat               Y
Caption Y Y Y Y Y Y Y Y
Columns       Y Y     Y
ColumnsEnabled       Y Y     Y
DefaultCollectionsPage   Y            
DefaultDetailsStaticPage Y              
DefaultDetailsWebPage   Y            
DefaultGalleryPage Y              
DefaultResultsPage   Y            
DefaultSearchPage   Y            
Description Y Y Y Y Y Y Y Y
DisplayFields       Y Y Y Y Y
DownloadOriginals               Y
ExportLocation Y              
FieldName     Y          
FooterHTML Y Y            
HeaderHTML Y Y            
HomePageURL Y Y            
Image Y Y Y Y Y Y Y Y
ImageSize           Y Y  
ImageSource           Y Y  
IncludeLinkToHomePage Y Y            
InputOption     Y          
LoadWebPagesInNewBrowser Y              
MajorVersion Y Y Y Y Y Y Y Y
MainLogoGraphic Y Y            
MinorVersion Y Y Y Y Y Y Y Y
OnClickAction       Y Y   Y Y
OnClickShowOriginal           Y    
PublishFromCurrentLocation   Y            
Rows       Y Y     Y
RowsEnabled       Y Y     Y
SaveWebTemplate Y              
SearchAllFields     Y          
SearchAllFieldsEnabled     Y          
SearchFields     Y          
SearchFieldsEnabled     Y          
selected     Y          
SelectedSearchOperators     Y          
SelectedWebServer   Y            
ServerSubFolder   Y            
SiteEditingPassword   Y            
SiteTitle Y Y            
SiteViewingPassword   Y            
ShowFindAll     Y          
ShowCollection         Y      
ShowCollectionAddDeleteOptions         Y   Y  
ShowCollectionAddDeleteOptionsEnabled         Y   Y  
ShowDownloadLink               Y
ShowDownloadOriginal             Y  
SortResults       Y Y     Y
SortSelection       Y Y     Y
StyleSheet     Y Y Y Y Y Y
SummarizeSearchCriteria       Y Y      
ThumbnailSize       Y Y     Y
ThumbnailSizeEnabled       Y Y     Y
UploadOriginalsWithSite   Y            
UploadPreviews   Y            
WelcomePageHTML Y Y            

Keywords (to assist indexing/searching):



Question: NP Dynamic Libraries and Properties [FAQ00373.htm]
Last Update:- 01 June 2006


<< NetPublish API ...
Back to Portfolio FAQ index
NP's paths and folders ... >>

Quick Search of PortfolioFAQ (word, words or phase): or try the Advanced Search

User-to-User Forums  |  Report error/typo/broken link  |  Request new topic  |  Ask a question

Site and articles © Mark Anderson 2001-2007 - Visit my home page


This FAQ is created and maintained using
Friday logo
Friday - The Automatic FAQ Maker