Справочное руководство по TDMS 5.0 API
TDMSApplication Объект Члены
Смотри также  Общее описание  Послать замечания

Glossary Item Box

Публичные Методы

Public Method AbortTransactionОткатывает (roll-back) открытую транзакцию.
Public Method AddNotifyДобавляет строку текста в Окно сообщений.
Public Method ClearNotifyОчищает список Окна сообщений
Public Method CommitTransactionЗавершает транзакцию.
Public Method CreateCollectionСоздает динамическую объектную коллекцию указанного типа.
Public Method CreateDictionaryCreate dictionary. Return 'Scripting.Dictionary' object
Public Method CreateEventСоздает объект типа TDMSEvent и добавляет его в Журнал событий. Позволяет создавать события произвольного типа с целью дополнения информации об истории работы приложения.
Public Method CreateMessageСоздает новое почтовое сообщение TDMSMessage.
Public Method CreateQueryСоздает динамическую выборку TDMSQuery.
Public Method CreateSheetСоздает виртуальную таблицу TDMSSheet.
Public Method DebugPrintmethod DebugPrint
Public Method ExecuteCommandВыполняет заданную команду TDMS.
Public Method ExecuteQueryВыполнить запрос - сохраненный или динамически созданный.
Public Method ExecuteScriptВыполнить заданный скрипт.
Public Method ExportClassifiersExport classifiers to xml-file. Params - dictionary of parameters: 'Objects', 'Cab'
Public Method ExportObjectsВыполнить экспорт указанного объекта или коллекции объектов в файл с заданным именем.
Public Method ExportObjectsXMLExport objects to xml-file
Public Method ExportObjectsXML2Export objects to xml-file. params - dictionary of parameters: 'Objects', 'ExportWithContent', 'ExportWithRoles', 'ExportWithFiles', 'ExportFilesWithBodies', 'Cab'
Public Method ExportSchemeЭкспортировать структуру базы TDMS в файл с заданным именем
Public Method ExportUsersmethod ExportUsers
Public Method ExportXMLSchememethod ExportXMLScheme. folder - export folder, itemNameCollection - TDMSCollection of sysIds, flagDoExport - flag do export, or just get filenames to export, exportedCollection - collection of exported filenames
Public Method GetObjectByGUIDПолучить объект по заданному идентификатору (GUID).
Public Method GetUnsynchronizedFilesGet unsynchronized files. First parameter 'objects' is objects or files collection to check files for unsynchronized. If it is empty then search all database. 'maxCount' parameter limit result collection. 'startAfterFile' parameter is for paging, return files ?j?\?
Public Method ImportClassifiersImport classifiers from xml-file. Params - dictionary of parameters: 'Mode'
Public Method ImportObjects

Импортировать коллекцию объектов из файла с заданным именем.

Public Method ImportObjectsXMLImport objects from xml-file. Mode parameter is replace mode: 0 - import recent, 1 - create version, 2 - new guid, 3 - skip from file, 4 - always replace from file
Public Method ImportObjectsXML2Import objects from xml-file. params - dictionary of parameters: 'RootForImport', 'Mode', 'ImportWithBodies'
Public Method ImportScheme

Импортировать структуру базы TDMS из файла с заданным именем.

Public Method ImportUsersmethod ImportUsers
Public Method ImportXMLSchememethod ImportXMLScheme. folder - import folder, itemNameCollection - TDMSCollection of sysIds or filenames, flagDoImport - flag do import or just get filenames to import, importedCollection - collection of imported filenames
Public Method LocalizedStringОсуществляет перевод строки
Public Method LockedObjectsПолучить коллекцию заблокированных объектов во всей системе или по выбранному пользователю.
Public Method LoginВыполнить процедуру входа пользователя в систему без показа диалогового окна "Вход в TDMS".
Public Method LoginDlgВызов диалога "Вход в TDMS"
Public Method QuitЗавершить работу приложения.
Public Method SaveContextObjectsmethod SaveContextObjects
Public Method StartTransactionОткрыть транзакцию.
Public Method StartTransactionWithLockmethod Start transaction and set lock. sLockName - name of lock(max 255 chars), lockTimeOut - time out in seconds, 0 - don't wait, -1 unlimited
Public Method SynchronizeObjectSynchronize object files to current user file server. 'object' - TdmsObject, which files must be synchronized, 'withContent' - flag for each object also syncronize it's objects content, 'forced'=True do it immediately, 'forced'=False - add to sync list
Public Method SynchronizeObjectsSynchronize files of objects to current user file server. 'objects' - array or collection of objects to sync, 'withContent' - flag for each object also syncronize it's objects content, 'forced'=True do it immediately, 'forced'=False - add to sync list

Публичные Свойства

Public Property ApplicationFolderПолный путь к  TDMS
Public Property ApplicationNameИмя текущей базы данных.
Public Property AttributeDefsКоллекция всех типов атрибутов, существующих в приложении.
Public Property AttributesКоллекция собственных атрибутов объекта TDMSApplication (системные атрибуты).
Public Property CallObjectsEventsFromCOMСвойство, указывающее, генерировать ли события в результате действий через COM интерфейс TDMS.
Public Property ClassifiersКоллекция классификаторов верхнего уровня (непосредственно подчиненных корневому разделу "Классификаторы").
Public Property CommandsКоллекция всех команд, существующих в приложении.
Public Property CurrentComputerВозвращает имя текущего компьютера.
Public Property CurrentTimeТекущее время на сервере базы данных TDMS.
Public Property CurrentUserТекущий пользователь приложения.
Public Property DatabaseLocation

Местонахождение текущей базы данных - строка в формате ИМЯ_СЕРВЕРА\ИМЯ_БАЗЫ_ДАННЫХ.

DatabaseLocation

Public Property DatabaseNameИмя текущей базы данных.
Public Property DatabaseTypeТип текущей базы данных.
Public Property DataServiceAddressget TdmsDataService (ManagedHost) address
Public Property DepartmentsКорневой классификатор "Отдел" (список подразделений предприятия).
Public Property DesktopУзел "Рабочий стол" Дерева объектов TDMS.
Public Property DialogsКоллекция диалогов TDMS, предназначенных для выполнения наиболее часто встречающихся действий.
Public Property DictionaryХранилище глобальных переменных приложения.
Public Property EventsКоллекция всех событий, зарегистрированных в приложении с момента установки.
Public Property FileDefsКоллекция всех типов файлов, определенных в приложении.
Public Property GetServiceService by name
Public Property GroupsКоллекция всех групп пользователей, созданных в приложении.
Public Property hWndДескриптор (handle) главного окна приложения.
Public Property IconsКоллекция всех значков (иконок), зарегистрированных в приложении.
Public Property InputFormsКоллекция всех форм ввода, созданных в приложении.
Public Property IsActiveTransactionФлаг "Открытая транзакция".
Public Property IsLoggedInФлаг, отображающий что TDMS подключен к базе данных (включая проверку учетной записи пользователя TDMS)
Public Property MailFolders

Коллекция почтовых папок, содержащихся в разделе "Почта" Дерева объектов TDMS.

Public Property MailRootFolder

Раздел "Почта" Дерева объектов TDMS.

Public Property MessagesКоллекция всех почтовых сообщений текущего пользователя.
Public Property ModeТип лицензии TDMS.
Public Property ObjectDefsКоллекция всех типов объектов, созданных в приложении.
Public Property OLERequestPendingTimeout

Определяет, как долго приложение будет ждать ответа от OLE - вызова

Public Property PositionsКорневой классификатор "Должность".
Public Property ProfilesКоллекция всех пользовательских профилей, созданных в приложении.
Public Property QueriesКоллекция всех глобальных выборок (сохраненных запросов), созданных в приложении.
Public Property RoleDefsКоллекция всех типов ролей, созданных в приложении.
Public Property RootУзел "Объекты" Дерева объектов TDMS.
Public Property ServerNameИмя сервера базы данных TDMS
Public Property ShellПользовательский интерфейс TDMS.
Public Property SignDefsКоллекция всех типов подписей, созданных в приложении.
Public Property StatusesКоллекция всех статусов, созданных в приложении.
Public Property UserMailRootВозвращает объект пердставляющий из себя корневую почтовую директорию пользователя
Public Property UsersВсе пользователи, зарегистрированные в приложении.
Public Property UtilityНабор дополнительных методов-утилит для работы с TDMS.
Public Property VersionВерсия текущего приложения TDMS.
Public Property VisibleПоказать/скрыть главное окно приложения.
Public Property WorkFolderПуть к папке, созданной на локальном жестком диске для выгрузки файлов редактируемых объектов.

События

Public Event BeforeQuitГенерируется в момент завершения работы TDMS перед закрытием главного окна приложения.
Public Event CommandBeforeExecuteГенерируется перед исполнением команды.
Public Event CommandCompletedГенерируется по завершении выполнения команды.
Public Event ContextMenuBeforeShowГенерируется перед выводом на экран контекстного меню объекта.
Public Event ContextMenuItemAddГенерируется перед добавлением каждой команды в контекстное меню.
Public Event ExportCompleted

Генерируется по окончании операции экспорта объектов в файл.

Public Event FileAddedГенерируется в случае успешного добавления файла к объекту. Если добавляется группа файлов - событие генерируется для каждого файла в отдельности.
Public Event FileBeforeAddГенерируется перед добавлением файла к объекту. Если добавляется группа файлов - событие генерируется для каждого файла в отдельности.
Public Event FileBeforeCheckInГенерируется перед загрузкой/обновлением содержимого файла объекта в файловом хранилище TDMS .
Public Event FileBeforeCheckOutГенерируется перед выгрузкой файла объекта на жесткий диск для редактирования или просмотра.
Public Event FileBeforeEraseГенерируется перед удалением файла объекта из файлового хранилища TDMS.
Public Event FileCheckedInГенерируется после успешной загрузки или обновления содержимого файла объекта в файловом хранилище TDMS .
Public Event FileCheckedOutГенерируется после успешной выгрузки файла объекта на жесткий диск для редактирования или просмотра.
Public Event FileErasedГенерируется в момент удаления файла из файлового хранилища.
Public Event FilesDragAndDroppedГенерируется после окончания перетаскивания файлов в окно TDMS посредством операции Drag&Drop.
Public Event FileUnsynchronizedmethod FileUnsynchronized
Public Event FileWorkFolderOverwritemethod FileWorkFolderOverwrite
Public Event FormAttributeChangeГенерируется после каждого изменения значения атрибута формы ввода при переключении фокуса ввода на другой элемент.
Public Event FormBeforeCloseГенерируется перед закрытием формы ввода. 
Public Event FormBeforeShowГенерируется в момент открытия формы ввода, но перед показом ее на экране.
Public Event FormTableAttributeBeforeRowAddГенерируется перед добавлением строки табличного атрибута на форме ввода
Public Event FormTableAttributeBeforeRowRemoveГенерируется перед удалением строки табличного атрибута на форме ввода
Public Event FormTableAttributeChangeГенерируется после изменения значения любого поля табличного атрибута при переключении фокуса ввода на другой элемент.
Public Event FormTableAttributeRowAddedГенерируется после добавленя строки табличного атрибута на форме ввода
Public Event FormTableAttributeRowOrderChangedГенерируется после изменения порядка строк в табличном атрибуте на форме ввода
Public Event FormTableAttributeRowRemovedГенерируется после удаления строки табличного атрибута на форме ввода
Public Event ImportCompleted

Генерируется по окончании операции импорта коллекции объектов из файла *.dat.

Public Event ListBeforeShowГенерируется перед перерисовкой Панели состава (даже если объект/выборка/классификатор состава не имеют).
Public Event MainWindowShownГенерируется после отображения/сокрытия главного окна приложения (включая сворачивание в трэй).
Public Event MessagesReceivedГенерируется при выполнении проверки новых почтовых сообщений, независимо от их наличия.
Public Event ObjectBeforeCheckInГенерируется перед обновлением содержимого файлов объекта в файловом хранилище TDMS после их редактирования/просмотра внешним приложением.
Public Event ObjectBeforeCheckOutГенерируется перед выгрузкой файлов объекта на жесткий диск (для редактирования или просмотра).
Public Event ObjectBeforeContentAddГенерируется перед добавлением объектов в состав родительского объекта.
Public Event ObjectBeforeContentRemoveГенерируется перед удалением объектов из состава родительского объекта.
Public Event ObjectBeforeCreateГенерируется перед созданием нового пользовательского объекта.
Public Event ObjectBeforeEraseГенерируется перед удалением объекта из базы данных TDMS.
Public Event ObjectBeforeModifyГенерируется перед сохранением изменений объекта, в момент закрытия Окна свойств.
Public Event ObjectBeforeSignГенерируется перед непосредственным подписыванием содержимого объекта подписью данного типа.
Public Event ObjectBeforeSignAddГенерируется перед добавлением шаблона подписи на объект (т.е. объект требуется подписать этим типом подписи)
Public Event ObjectBeforeSignDropГенерируется перед пометкой подписи как недействительной, когда пользователь отозвал свою подпись.
Public Event ObjectBeforeSignEraseГенерируется перед удалением шаблона подписи с объекта (удаление возможно только неподписанной, не действительной, или отозваной подписи)
Public Event ObjectCheckedInГенерируется после успешного обновления файлов объекта.
Public Event ObjectCheckedOutГенерируется после успешной выгрузки файлов объекта на жесткий диск (для редактирования или просмотра).
Public Event ObjectCheckExternalSignГенерируется при проверке подписи на действительность. Обработчик события должен быть реализован, если для подписывания используются сторонние приложения.
Public Event ObjectContentAddedГенерируется после успешного добавления объектов в состав родительского объекта.  
Public Event ObjectContentRemovedГенерируется после успешного удаления объектов из состава родительского объекта.
Public Event ObjectCreatedГенерируется после успешного создания нового объекта.
Public Event ObjectErasedГенерируется в момент удаления объекта из базы данных TDMS.
Public Event ObjectImported

Генерируется по окончании операции импорта для каждого из импортированных объектов.

Public Event ObjectModifiedГенерируется после успешного сохранения изменений объекта.
Public Event ObjectPropertiesDlgBeforeCloseГенерируется перед закрытием Окна свойств объекта.
Public Event ObjectPropertiesDlgInitГенерируется перед инициализацией диалога свойств обьекта. Позволяет выбрать начальную вкладку для отображения, запомнить исходные параметры в словаре и т.д.
Public Event ObjectPropertiesDlgShowГенерируется перед выводом на экран Окна свойств объекта.
Public Event ObjectsBeforeEraseГенерируется перед удалением коллекции объектов из системы.
Public Event ObjectsErasedГенерируется в момент удаления коллекции объектов из базы данных TDMS.
Public Event ObjectSignAddedГенерируется когда добавлен шаблон подписи на объект (т.е. объект требуется подписать этим типом подписи)
Public Event ObjectSignDroppedГенерируется когда пользователь отозвал подпись. (Подпись недействительна)
Public Event ObjectSignedГенерируется когда подпись проставлена. (Т.е. пользователь подписал объект данным типом подписи)
Public Event ObjectSignErasedГенерируется когда шаблон подписи удалён с объекта (удаление возможно только неподписанной, не действительной, или отозваной подписи)
Public Event ObjectSignExternalPropertiesDlgСобытие возникает при нажатии кнопки Дополнительно на диалоге свойств подписи. Для отображения дополнительных свойств внешней подписи, если таковые имеются.
Public Event ObjectStatusBeforeChangeГенерируется перед изменением статуса обьекта
Public Event ObjectStatusChangedГенерируется после изменения статуса обьекта
Public Event OnDDEГенерируется перед вызовом стандартного TDMS-обработчика DDE команд
Public Event OnNotifymethod OnNotify
Public Event OnScriptErrorГенерируется при возникновении ошибки выполнения скрипта (ошибка VBS или внутреннего контроля API COM TDMS)
Public Event QueryAfterExecuteГенерируется после выполнения запроса, но перед отображением результатов на экране.
Public Event QueryBeforeExecuteГенерируется перед выполнением запроса.
Public Event QuitГенерируется в момент завершения работы TDMS после закрытия главного окна приложения.
Public Event StartupГенерируется при запуске TDMS - после закрытия диалога входа в систему, но перед открытием главного окна приложения.
Public Event TimerГенерируется один раз в 10 секунд с момента запуска приложения.
Public Event VersionBeforeCreate

Генерируется перед созданием версии обьекта

Public Event VersionCreatedГенерируется после создания версии обьекта

Смотри также

© 2016 CSoft Development. Все права защищены.