Replace a Range with text

Replaces a Range with text in a Word document.

Replace a Range with text in a Word document REST API

Server	Method	Endpoint
`https://api.aspose.cloud/v4.0`	PUT	`/words/online/post/range/{rangeStartIdentifier}/{rangeEndIdentifier}`

, where:

rangeStartIdentifier (required) — the range start identifier.
rangeEndIdentifier — the range end identifier.

You can use the following parameters in a REST request:

Parameter Name	Data Type	Required/Optional	Description
`loadEncoding`	string	Optional	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
`password`	string	Optional	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
`encryptedPassword`	string	Optional	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
`destFileName`	string	Optional	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

Use $multipart/form-data request to combine one or more properties into a single body:

Property Name	Data Type	Required/Optional	Description
`document`	string(binary)	Required	The document.
`rangeText`	ReplaceRange	Required	Model with text for replacement.

Note: to access this REST API, you need to register and get personal credentials. Use the ‘Quick Start’ guide to go through the procedure in a couple of minutes.

Replace a Range with text in a Word document usage examples

Let’s look at practical examples of using the web service. You can do this both with cURL and Postman utilities, and from your code in various programming languages: Python, Java, JavaScript, C#, PHP, C++, Go, Ruby, Swift, Dart.

How to replace a Range with text in a Word document with cURL or Postman

One of the easiest and fastest ways to call a REST API is to use cURL or Postman:

cURL Request

	curl -v "https://api.aspose.cloud/v4.0/words/online/post/range/id0.0.0/id0.0.1" \
	-X PUT \
	-H "Content-Type: multipart/form-data" \
	-H "Authorization: Bearer ####################" \
	-F Document="@Sample.doc" \
	-F RangeText="{\"Text\":\"Replaced header\"}"

view raw ReplaceWithTextOnline.curl hosted with ❤ by GitHub

To get a JWT token use these instructions

Postman Request

	{
	"info": {
	"name": "ReplaceWithTextOnline",
	"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"auth": {
	"type": "oauth2",
	"oauth2": [
	{
	"key": "clientSecret",
	"value": "{{CLIENT_SECRET}}",
	"type": "string"
	},
	{
	"key": "clientId",
	"value": "{{CLIENT_ID}}",
	"type": "string"
	},
	{
	"key": "addTokenTo",
	"value": "header",
	"type": "string"
	},
	{
	"key": "client_authentication",
	"value": "body",
	"type": "string"
	},
	{
	"key": "accessTokenUrl",
	"value": "https://api.aspose.cloud/connect/token",
	"type": "string"
	},
	{
	"key": "grant_type",
	"value": "client_credentials",
	"type": "string"
	},
	{
	"key": "tokenName",
	"value": "Access Token",
	"type": "string"
	}
	]
	},
	"item": [
	{
	"name": "replaceRequest",
	"protocolProfileBehavior": {
	"disableBodyPruning": true
	},
	"request": {
	"method": "PUT",
	"header": [
	],
	"body": {
	"mode": "formdata",
	"formdata": [
	{
	"key": "Document",
	"type": "file",
	"src": "Sample.doc"
	},
	{
	"key": "RangeText",
	"type": "text",
	"value": "{\"Text\":\"Replaced header\"}"
	}
	]
	},
	"url": {
	"raw": "https://api.aspose.cloud/v4.0/words/online/post/range/id0.0.0/id0.0.1",
	"protocol": "https",
	"host": [
	"api",
	"aspose",
	"cloud"
	],
	"path": [
	"v4.0",
	"words",
	"online",
	"post",
	"range",
	"id0.0.0",
	"id0.0.1"
	],
	"query": [
	]
	}
	},
	"response": []
	}
	],
	"variable": [
	]
	}

view raw ReplaceWithTextOnline.json hosted with ❤ by GitHub

To get a JWT token use these instructions

How to replace a Range with text in a Word document in Python, Java, C#, C++, JavaScript and other programming languages

Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:

	import os
	import asposewordscloud
	import asposewordscloud.models.requests
	from asposewordscloud.rest import ApiException
	from shutil import copyfile

	words_api = WordsApi(client_id = '####-####-####-####-####', client_secret = '##################')
	request_document = open('Sample.doc', 'rb')
	request_range_text = asposewordscloud.ReplaceRange(text='Replaced header')
	replace_request = asposewordscloud.models.requests.ReplaceWithTextOnlineRequest(document=request_document, range_start_identifier='id0.0.0', range_text=request_range_text, range_end_identifier='id0.0.1')
	words_api.replace_with_text_online(replace_request)

	import com.aspose.words.cloud.*;
	import com.aspose.words.cloud.api.*;
	import com.aspose.words.cloud.model.*;
	import com.aspose.words.cloud.model.requests.*;
	import com.aspose.words.cloud.model.responses.*;
	import java.nio.file.Files;
	import java.nio.file.Paths;

	ApiClient apiClient = new ApiClient(/clientId/ "####-####-####-####-####", /clientSecret/ "##################", null);
	WordsApi wordsApi = new WordsApi(apiClient);
	byte[] requestDocument = Files.readAllBytes(Paths.get("Sample.doc").toAbsolutePath());
	ReplaceRange requestRangeText = new ReplaceRange();
	requestRangeText.setText("Replaced header");

	ReplaceWithTextOnlineRequest replaceRequest = new ReplaceWithTextOnlineRequest(requestDocument, "id0.0.0", requestRangeText, "id0.0.1", null, null, null, null);
	wordsApi.replaceWithTextOnline(replaceRequest);

	import * as fs from "fs";

	const clientId = "####-####-####-####-####";
	const secret = "##################";
	const wordsApi = new WordsApi(clientId, secret);
	const requestDocument = fs.createReadStream("Sample.doc");
	const requestRangeText = new model.ReplaceRange({
	text: "Replaced header"
	})
	const replaceRequest = new model.ReplaceWithTextOnlineRequest({
	document: requestDocument,
	rangeStartIdentifier: "id0.0.0",
	rangeText: requestRangeText,
	rangeEndIdentifier: "id0.0.1"
	});

	wordsApi.replaceWithTextOnline(replaceRequest)
	.then((replaceRequestResult) => {
	// tslint:disable-next-line:no-console
	console.log("Result of replaceRequest: ", replaceRequestResult);
	});

	using System;
	using System.Collections.Generic;
	using System.IO;
	using System.Linq;
	using System.Threading.Tasks;
	using Aspose.Words.Cloud.Sdk;
	using Aspose.Words.Cloud.Sdk.Model;
	using Aspose.Words.Cloud.Sdk.Model.Requests;

	var config = new Configuration { ClientId = "####-####-####-####-####", ClientSecret = "##################" };
	var wordsApi = new WordsApi(config);
	using var requestDocument = File.OpenRead("Sample.doc");
	var requestRangeText = new ReplaceRange()
	{
	Text = "Replaced header"
	};
	var replaceRequest = new ReplaceWithTextOnlineRequest(requestDocument, "id0.0.0", requestRangeText, rangeEndIdentifier: "id0.0.1");
	await wordsApi.ReplaceWithTextOnline(replaceRequest);

Replace a Range with text

Replace a Range with text in a Word document REST API

Replace a Range with text in a Word document usage examples

How to replace a Range with text in a Word document with cURL or Postman

How to replace a Range with text in a Word document in Python, Java, C#, C++, JavaScript and other programming languages

See Also