Assembly: Microsoft.Synchronization.Data (in microsoft.synchronization.data.dll)
A synchronization table is defined for each table that is synchronized. It stores settings, such as the direction of synchronization. Each client can request only the tables that it needs. This might not include all the tables that the server synchronization provider makes available. For example, there might be 20 tables, 10 of which are configured for bidirectional synchronization in the Server Synchronization Provider. A client might request only 12 of the tables as download-only. Although the server supports upload, the client does not have to make changes or to synchronize all tables.
The following code example is from a class that derives from SyncAgent. The code creates two synchronization groups and three synchronization tables. The
Customer table is added to the
Customer group, and the
OrderDetail tables are added to the
Order group. All tables are download-only. If a table exists at the client, the table is dropped and re-created during the initial synchronization. To view this code in the context of a complete example, see How to: Filter Rows and Columns.
//Create two SyncGroups so that changes to OrderHeader //and OrderDetail are made in one transaction. Depending on //application requirements, you might include Customer //in the same group. SyncGroup customerSyncGroup = new SyncGroup("Customer"); SyncGroup orderSyncGroup = new SyncGroup("Order"); //Add each table: specify a synchronization direction of //DownloadOnly. SyncTable customerSyncTable = new SyncTable("Customer"); customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable; customerSyncTable.SyncDirection = SyncDirection.DownloadOnly; customerSyncTable.SyncGroup = customerSyncGroup; this.Configuration.SyncTables.Add(customerSyncTable); SyncTable orderHeaderSyncTable = new SyncTable("OrderHeader"); orderHeaderSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable; orderHeaderSyncTable.SyncDirection = SyncDirection.DownloadOnly; orderHeaderSyncTable.SyncGroup = orderSyncGroup; this.Configuration.SyncTables.Add(orderHeaderSyncTable); SyncTable orderDetailSyncTable = new SyncTable("OrderDetail"); orderDetailSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable; orderDetailSyncTable.SyncDirection = SyncDirection.DownloadOnly; orderDetailSyncTable.SyncGroup = orderSyncGroup; this.Configuration.SyncTables.Add(orderDetailSyncTable);