ViewSecurityKey Property

The ViewSecurityKey property is used to define the security key that is required to open a form.

Assigning the Key

Assigning the ViewSecurityKey property can be done through the property sheet of the form designer or programmatically. The Security Key Type Editor (link) is used to search for the appropriate security key to assign to the ViewSecurityKey property.

Sample – Setting the ViewSecurityKey Property [Visual Basic]

Imports MicroFour.StrataFrame.UI.Windows.Forms
...
Public Sub TestSecurity()
    '-Create a new form, set the security key and show it
    Dim loForm As New StandardForm()
    loForm.ViewSecurityKey = "MySecurityKey"
    loForm.Show()
End Sub

Sample – Setting the ViewSecurityKey Property [C#]

using MicroFour.StrataFrame.UI.Windows.Forms;
...
public void TestSecurity()
{
    //-- Create a new form, set the security key and show it
    StandardForm loForm = new StandardForm();
    loForm.ViewSecurityKey = "MySecurityKey";
    loForm.Show();
}

How the ViewSecurityKey Affects a Form at Run-time

Action	Result
ViewSecurityKey left blank	Security is not checked on the form, and the form is always shown.
ViewSecurityKey set, permission granted	The user has permission to view the form, and the form is shown.
ViewSecurityKey set, permission denied, denied action set to NoMessage	The form is not shown to the end-user and a MessageForm is shown to the end user containing the DefaultBlockedMessage.
ViewSecurityKey set, permission denied, denied action set to Message	The form is not shown to the end-user and a MessageForm is show to the end-user containing the message assigned within the SecurityDialog.
ViewSecurityKey set, permission denied, denied action set to MessageKey	The form is not shown to the end-user and a MessageForm is shown to the end-user containing a message that is retrieved from the localization data by the given message key.
ViewSecurityKey set, permission denied, denied action set to ReplaceEachChar	The form is not shown to the end-user and a MessageForm is shown to the end-user containing the DefaultBlockedMessage.
ViewSecurityKey set, permission set to read-only	The form is not shown to the end-user and a MessageForm is shown to the end-user containing the DefaultBlockedMessage.
ViewSecurityKey set, user changes while app is running, permission denied	The form remains shown, but is covered by a "Form Locked" panel that prevents the contents of the form from being displayed. Additionally, the form cannot be closed until a user with sufficient rights to view the form logs back into the application.

StrataFrame Security Documentation	Send comments on this topic.
Form-Level Security Keys