|
Метод TryEdit – проверить возможность редактирования версии |
 
 |
|
Метод TryEdit – проверить возможность редактирования версии |
|
Синтаксис:
|
function TryEdit( EditMode: TEditMode; out ErrorMessage: WideString): WordBool; |
Параметры:
EditMode – режим редактирования версии;
ErrorMessage – системное сообщение об ошибке IS-Builder. Параметр будет означен, если версию нельзя редактировать в указанном режиме.
Возвращаемое значение:
Возможность редактирования версии: True, если версию можно редактировать в режиме EditMode, иначе False.
Описание:
Метод проверяет, можно ли редактировать версию в режиме EditMode. Если можно редактировать версию, то метод возвращает True, если нет, то метод возвращает False и заполняет параметр ErrorMessage.
В качестве параметра EditMode можно передавать одно из следующих значений:
| · | emLock; |
| · | emEdit; |
| · | emSign; |
| · | emExportWithLock; |
| · | emImportWithUnlock; |
| · | emChangeVersionNote; |
| · | emOpenForModify; |
| · | emChangeLifeStage; |
| · | emDelete; |
| · | emCreateVersion; |
| · | emImport; |
| · | emUnlockExportedWithLock; |
| · | emChangeRights; |
| · | emRecoveryFromLocalCopy; |
| · | emChangeEncodeTypeToCertificate; |
| · | emChangeEncodeTypeToPassword; |
| · | emChangeEncodeTypeToNone; |
| · | emChangeEncodeTypeToCertificatePassword; |
| · | emGetText; |
| · | emOpenForView; |
| · | emMoveToStorage; |
| · | emCreateObject; |
| · | emChangeVersionHidden; |
| · | emDeleteVersion; |
| · | emChangeLifeCycleStage; |
| · | emApprovingSign; |
| · | emExport. |
Если в качестве параметра EditMode передать недопустимый для версии электронного документа режим редактирования, то будет сгенерировано исключение.
Примечание. Параметр ErrorMessage является выходным параметром. Значение выходного параметра доступно после выполнения метода. Для его получения в параметре ErrorMessage следует передавать указатель на строковую переменную. В вычислениях ISBL для этого нужно:
- инициализировать переменную строковым значением;
- в вызове метода после имени переменной указать символ «^».
Пример использования:
// Проверить возможность блокирования документа.
// EDocument – электронный документ.
// ErrorMessage – сообщение об ошибке.
ErrorMessage =''
if not EDocument.Versions.Values(0).TryEdit(emLock; ErrorMessage^)
Exit(ErrorMessage)
endif
|
Метод EnterEditMode Метод IEDMSObject.TryEdit Свойство GlobalLock |
