Skip to main content

Document

The document object is the object in which the forms designed in the designed process and the information on the form are kept. When added to the stream, the document object cannot be linked to any other object with the link arrow, nor does another object's arrow bind to the Document object. The object is in the stream; Objects such as position, position group, information, etc. are added as documents and the project form to which the document object is linked is displayed in the relevant step.

When the object in the Flow design screen is clicked, the object properties appear in the Property Viewer panel.

When the document object is clicked, there are "Appearance", "Properties" and "Events" tabs in the Property Viewer panel.

Document

Appearance​

Text Configs​

'Object Name' - The name of the object to be used on the system side. On the code side, the object is accessed by the value that is written in the object name field.

'Caption' - The area where the object's title text is entered.

'Is Lock' - This field is activated if the object is not to be moved at the time of design.

'Size' - The part where the width and height of the object are adjusted.

Properties​

Document​

'Document Type' - Select the type of document to keep in the document object. The field lists the options "Fixed document" and "Current document".

{#static-document} if fixed document is selected​

If Fixed document is selected in the 'Process' - Document Type field, the Process field becomes visible. If the document of the process is to be created, that process should be selected from the list.

If Fixed Document is selected in the 'Form' - Document Type field, the Process field becomes visible. The Process field lists the forms within the selected process.

If Fixed Document is selected in the 'View' - Document Type field, the Process area becomes visible. The Form field lists the views that are contained within the selected form.

'Panel Size' - Used to specify the width of the panel when the form is opened in the panel type while the selected form is displayed in the web interface.

INFO

Opening a panel so that a value of 1 in the width of the panel covers 1/3 of the screen, a value of 2 means opening a panel to cover 2/3 of the screen, and a value of 3 means opening a panel so that it covers 3/3 of the screen (all).

'Parameters' - The field where the parameter value is sent into the selected project-form and defined for the use of these parameters in the form.

For example, by defining parameters to the form defined in the Documents object, it is possible to transfer parameters from the object or in the form of a constant value to the form contained in the Document object where the parameter is defined in the Form field for an event defined in the object such as Position, Position Group on the flow side.

INFO

The ResponseParameters (Client or Server) method must be used to use parameters sent to the form on the Documents object within the form.

Example server-side usage;

''csharp void Form1_OnLoad(object sender, LoadEventArgs e) { if (ResponseParameters.TryGetValue("ParameterName", out object parameterValue)) { // } }


{#existing-document} if current document is selected​

'Path' - In case it is desired to keep a form saved in the system in the document object, the relevant form index is selected from the Document Management System structure by clicking on the field. In this way, a process form that has already been created on the system can be kept in the Document object.

'Panel Size' - Used to specify the width of the panel when the form is opened in the panel type while the selected document is displayed in the web interface.

INFO

Opening a panel so that a value of 1 in the width of the panel covers 1/3 of the screen, a value of 2 means opening a panel to cover 2/3 of the screen, and a value of 3 means opening a panel so that it covers 3/3 of the screen (all).

'Parameters' - The field where the parameter value is sent into the selected project-form and defined for the use of these parameters in the form.

For example, by defining parameters to the form defined in the Documents object, it is possible to transfer parameters from the object or in the form of a constant value to the form contained in the Document object where the parameter is defined in the Form field for an event defined in the object such as Position, Position Group on the flow side.

INFO

It is checked by the system that the attached properties on the object are correct. When a missing feature is found, a red exclamation point icon can be displayed on the object, and hovering over the icon with the mouse pointer can display what is missing or incorrect.

Document

Events​

Events​

The events owned by the document object are located in the "Events" tab in the Property Viewer panel. Each event is triggered at different runtime moments, performing its own unique operations. Code written by the developer to these events is also executed at the time the corresponding event is triggered. To write code for any event, double-click the appropriate event line from the Events tab. The screen is directed to the flow code editor section named "FlowName.cs" and the method block for the clicked event is automatically created. The developer can construct any code block he wants in this method. Next to the event whose method is created on the code side by clicking from the Events tab, the method name information is automatically generated and the relationship between the event and the method is specified.

Document