slreq.getDocumentInterface

Get instance of registered document interface

Since R2023a

collapse all in page

    Syntax

    customDocInterface = slreq.getDocumentInterface(docInterfaceName)

    Description

    customDocInterface = slreq.getDocumentInterface(docInterfaceName) returns an instance of the document interface with the registration name docInterfaceName. Use this function to create a custom document interface.

    example

    Examples

    collapse all

    This example shows how to create a custom document interface based on the Microsoft® Word interface.

    Define a function called myCustomWord that creates an instance of the built-in document interface for Microsoft Word by using slreq.getDocumentInterface.

    function docDomain = myCustomWord
docDomain = slreq.getDocumentInterface("linktype_rmi_word");
end

    Set the registration of the document interface to use the myCustomWord function by using the Registration property. Modify the name of the interface by using the Label property.

    function docDomain = myCustomWord
docDomain.Registration = mfilename;
docDomain.Label = "Custom Word";
end

    Register the custom document interface.

    rmi register myCustomWord

    Input Arguments

    collapse all

    Name of the registered document interface used to integrate with third-party applications, specified as a string scalar or character vector. To get the accepted values, use slreq.getLinkableTypes. You do not need to include the linktype prefix.

    Example: docDomain = slreq.getDocumentInterface("linktype_rmi_word");

    Output Arguments

    collapse all

    Document interface object, returned as a ReqMgr.LinkableType object.

    Version History

    Introduced in R2023a

    See Also

    Functions

    Topics