Click or drag to resize

saveAndWait Method

Save (synchronously) the document currently open in the PdfWebControl instance and wait for save to complete.

Syntax
JavaScript
Copy
function saveAndWait();

Parameters

None

Return Value

Type: Boolean

true if operation completed successfully; otherwise, false.

Remarks

This method will not raise the client side "saving" event in the Client API (but will still call the OnDocumentSaving method of an attached PdfIntegrationProvider).

Examples

Simple Example

JavaScript
Copy
var myApi = new PdfWebControlApi("PdfWebControl1"); // where "PdfWebControl1" is the ID (ClientID) assigned to the PdfWebControl instance
 myApi.saveAndWait(); //this will save the data currently in PdfWebControl synchronously (wait until complete)

Full Example

This example illustrates how to use the JavaScript PdfWebControlApi Class to save all current data in PdfWebControl instance before submitting a post back.

The following examples uses a ASP.NET page which as a PdfWebControl on it and a single code behind page.

ASP.NET Code

XML
Copy
<%@ Page Language="VB" AutoEventWireup="false" CodeFile="Save.aspx.vb" Inherits="_Default" %>

<%@ Register Assembly="RadPdf" Namespace="RadPdf.Web.UI" TagPrefix="radPdf" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body style="margin:0px">
    <form id="form1" runat="server">
    <div>
        <radPdf:PdfWebControl ID="PdfWebControl1" RunAt="server" Height="600px" Width="850px" HideSaveButton="True" />

        <asp:button id="Button1" runat="server" text="Save" OnClientClick="return PdfSave();" />

    <script type="text/javascript">
        function PdfSave()
        {
          return (new PdfWebControlApi("<%=Me.PdfWebControl1.ClientID%>")).saveAndWait();
        }
      </script>
    </div>
    </form>
</body>
</html>

VB Code Behind

VB
Copy
Option Explicit On
Option Strict On

Partial Class _Default
    Inherits System.Web.UI.Page

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load

        If Not IsPostBack Then

            Me.PdfWebControl1.CreateDocument("test", System.IO.File.ReadAllBytes("C:\fw4.pdf"))

        End If
    End Sub
End Class

Notice the value of property "OnClientClick" for Button1.

JavaScript
Copy
return (new PdfWebControlApi('PdfWebControl1')).saveAndWait();

This code will return true when it has saved the document to the server, allowing the PostBack to continue.

Examining the code more closely, we see that the JavaScript class PdfWebControlApi is created passing the id of the PdfWebControl to the constructor. This then makes a new instance of this object which we can call the saveAndWait Method against.

See Also