public interface Report extends NXObject
Modifier and Type | Interface and Description |
---|---|
static class |
Report.MoveItemLocation
Represents the moving item location.
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
clearTemplateItems()
Clears all template items in
Report . |
IUserItem |
copyUserItem(IUserItem userItem)
Copy an user item to the
Report . |
IUserItem |
createUserItem(UserInput.Type inputType)
Creates a user item and adds it to the report.
|
void |
deleteUserItems()
Deletes all user items in
Report . |
void |
export(String reportDocument,
boolean listError)
Exports the report contents to a document.
|
TemplateItem[] |
getTemplateItems()
Gets all template items.
|
IUserItem[] |
getUserItems()
Gets all user items in the report.
|
void |
hideTempalteItemsWithoutInput(boolean hideTemplateItemsWithoutInput)
Hide template items without user input in
Report . |
void |
moveUserItems(IUserItem[] userItems,
Report.MoveItemLocation newLocation,
IUserItem referencedItem)
Moves the user items to the new position.
|
IReportCollection |
reportCollection()
Returns the report collection object.
|
void |
setTemplateFile(String templateFile)
License requirements: None. |
void |
synchronizeWithCommands()
Synchronize the
Report with commands. |
String |
templateFile()
Returns the template document file.
|
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
TemplateItem[] getTemplateItems() throws NXException, RemoteException
NXException
RemoteException
IUserItem createUserItem(UserInput.Type inputType) throws NXException, RemoteException
inputType
- NXException
RemoteException
IUserItem copyUserItem(IUserItem userItem) throws NXException, RemoteException
userItem
- input user itemNXException
RemoteException
IUserItem[] getUserItems() throws NXException, RemoteException
NXException
RemoteException
void moveUserItems(IUserItem[] userItems, Report.MoveItemLocation newLocation, IUserItem referencedItem) throws NXException, RemoteException
userItems
- newLocation
- referencedItem
- the target reference user itemNXException
RemoteException
IReportCollection reportCollection() throws NXException, RemoteException
NXException
RemoteException
void export(String reportDocument, boolean listError) throws NXException, RemoteException
reportDocument
- listError
- list error information in listing windowNXException
RemoteException
String templateFile() throws NXException, RemoteException
NXException
RemoteException
void setTemplateFile(String templateFile) throws NXException, RemoteException
templateFile
- Template file name with full pathNXException
RemoteException
void clearTemplateItems() throws NXException, RemoteException
NXException
RemoteException
void deleteUserItems() throws NXException, RemoteException
NXException
RemoteException
void hideTempalteItemsWithoutInput(boolean hideTemplateItemsWithoutInput) throws NXException, RemoteException
hideTemplateItemsWithoutInput
- NXException
RemoteException
void synchronizeWithCommands() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.