Skip to content

Commit f5c92c1

Browse files
SergeiTerentevSergeiTerentev
committed
Added description and examples for BackgroundColor convert option
1 parent bf91af2 commit f5c92c1

2 files changed

Lines changed: 231 additions & 0 deletions

File tree

‎content/conversion/developer-guide/advanced-usage/conversion-options-by-document-family/convert-to-image-formats.md‎

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,3 +1006,228 @@ func ConvertToImage() {
10061006
```
10071007
10081008
{{< /tab >}} {{< /tabs >}}
1009+
1010+
## Convert to PNG with Background Color
1011+
1012+
This example demonstrates how to convert documents to PNG format with a specified background color.
1013+
1014+
### SDK examples
1015+
1016+
The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list [here](https://github.com/groupdocs-conversion-cloud).
1017+
1018+
{{< tabs "example7">}} {{< tab "C#" >}}
1019+
1020+
```csharp
1021+
// filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1022+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet-samples
1023+
string MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1024+
string MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1025+
1026+
var configuration = new Configuration(MyAppSid, MyAppKey);
1027+
1028+
// Create necessary API instances
1029+
var apiInstance = new ConvertApi(configuration);
1030+
1031+
// Prepare convert settings
1032+
var settings = new ConvertSettings
1033+
{
1034+
FilePath = "WordProcessing/four-pages.docx",
1035+
Format = "png",
1036+
ConvertOptions = new PngConvertOptions
1037+
{
1038+
FromPage = 1,
1039+
PagesCount = 2,
1040+
BackgroundColor = "white"
1041+
},
1042+
OutputPath = "converted"
1043+
};
1044+
1045+
// Convert to specified format
1046+
var response = apiInstance.ConvertDocument(new ConvertDocumentRequest(settings));
1047+
```
1048+
1049+
{{< /tab >}} {{< tab "Java" >}}
1050+
1051+
```java
1052+
// filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1053+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples
1054+
String MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1055+
String MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1056+
1057+
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
1058+
1059+
// Create API instance
1060+
ConvertApi apiInstance = new ConvertApi(configuration);
1061+
1062+
// Prepare convert settings
1063+
ConvertSettings settings = new ConvertSettings();
1064+
settings.setFilePath("WordProcessing/four-pages.docx");
1065+
settings.setFormat("png");
1066+
1067+
PngConvertOptions convertOptions = new PngConvertOptions();
1068+
convertOptions.setFromPage(1);
1069+
convertOptions.setPagesCount(2);
1070+
convertOptions.setBackgroundColor("white");
1071+
1072+
settings.setConvertOptions(convertOptions);
1073+
settings.setOutputPath("converted");
1074+
1075+
List<StoredConvertedResult> result = apiInstance.convertDocument(new ConvertDocumentRequest(settings));
1076+
```
1077+
1078+
{{< /tab >}} {{< tab "PHP" >}}
1079+
1080+
```php
1081+
// filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1082+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php-samples
1083+
use GroupDocs\Conversion\Model;
1084+
use GroupDocs\Conversion\Model\Requests;
1085+
1086+
$AppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1087+
$AppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1088+
1089+
$configuration = new GroupDocs\Conversion\Configuration();
1090+
$configuration->setAppSid($AppSid);
1091+
$configuration->setAppKey($AppKey);
1092+
1093+
$apiInstance = new GroupDocs\Conversion\ConvertApi($configuration);
1094+
1095+
// Prepare convert settings
1096+
$settings = new Model\ConvertSettings();
1097+
$settings->setFilePath("WordProcessing/four-pages.docx");
1098+
$settings->setFormat("png");
1099+
1100+
$convertOptions = new Model\PngConvertOptions();
1101+
$convertOptions->setFromPage(1);
1102+
$convertOptions->setPagesCount(2);
1103+
$convertOptions->setBackgroundColor("white");
1104+
1105+
$settings->setConvertOptions($convertOptions);
1106+
$settings->setOutputPath("converted");
1107+
1108+
// Convert
1109+
$result = $apiInstance->convertDocument(new Requests\ConvertDocumentRequest($settings));
1110+
```
1111+
1112+
{{< /tab >}} {{< tab "Ruby" >}}
1113+
1114+
```ruby
1115+
# filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1116+
# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby-samples
1117+
require 'groupdocs_conversion_cloud'
1118+
1119+
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1120+
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1121+
1122+
# Create necessary API instances
1123+
apiInstance = GroupDocsConversionCloud::ConvertApi.from_keys($app_sid, $app_key)
1124+
1125+
# Prepare convert settings
1126+
settings = GroupDocsConversionCloud::ConvertSettings.new
1127+
settings.file_path = "WordProcessing/four-pages.docx"
1128+
settings.format = "png"
1129+
convertOptions = GroupDocsConversionCloud::PngConvertOptions.new
1130+
convertOptions.from_page = 1
1131+
convertOptions.pages_count = 2
1132+
convertOptions.background_color = "white"
1133+
settings.convert_options = convertOptions
1134+
settings.output_path = "converted"
1135+
1136+
# Convert
1137+
result = apiInstance.convert_document(GroupDocsConversionCloud::ConvertDocumentRequest.new(settings))
1138+
```
1139+
1140+
{{< /tab >}} {{< tab "Node.js" >}}
1141+
1142+
```js
1143+
// filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1144+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node-samples
1145+
global.conversion_cloud = require("groupdocs-conversion-cloud");
1146+
1147+
global.appSid = "XXXX-XXXX-XXXX-XXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1148+
global.appKey = "XXXXXXXXXXXXXXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1149+
1150+
global.convertApi = conversion_cloud.ConvertApi.fromKeys(appSid, appKey);
1151+
1152+
let settings = new conversion_cloud.ConvertSettings();
1153+
settings.filePath = "WordProcessing/four-pages.docx";
1154+
settings.format = "png";
1155+
1156+
let convertOptions = new conversion_cloud.PngConvertOptions();
1157+
convertOptions.fromPage = 1;
1158+
convertOptions.pagesCount = 2;
1159+
convertOptions.backgroundColor = "white";
1160+
1161+
settings.convertOptions = convertOptions
1162+
settings.outputPath = "converted";
1163+
1164+
let result = await convertApi.convertDocument(new conversion_cloud.ConvertDocumentRequest(settings));
1165+
```
1166+
1167+
{{< /tab >}} {{< tab "Python" >}}
1168+
1169+
```python
1170+
# filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1171+
# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python-samples
1172+
import groupdocs_conversion_cloud
1173+
1174+
app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1175+
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
1176+
1177+
# Create necessary API instances
1178+
apiInstance = groupdocs_conversion_cloud.ConvertApi.from_keys(Common.app_sid, Common.app_key)
1179+
1180+
# Prepare convert settings
1181+
settings = groupdocs_conversion_cloud.ConvertSettings()
1182+
settings.file_path = "WordProcessing/four-pages.docx"
1183+
settings.format = "png"
1184+
convertOptions = groupdocs_conversion_cloud.PngConvertOptions()
1185+
convertOptions.from_page = 1
1186+
convertOptions.pages_count = 2
1187+
convertOptions.background_color = "white"
1188+
settings.convert_options = convertOptions
1189+
settings.output_path = "converted"
1190+
1191+
# Convert
1192+
result = apiInstance.convert_document(groupdocs_conversion_cloud.ConvertDocumentRequest(settings))
1193+
```
1194+
1195+
{{< /tab >}} {{< tab "Go" >}}
1196+
1197+
```go
1198+
// filepath: d:\GroupDocsCloud\Conversion\Docs\content\conversion\developer-guide\advanced-usage\conversion-options-by-document-family\convert-to-image-formats.md
1199+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples
1200+
package convert
1201+
1202+
import (
1203+
"fmt"
1204+
1205+
"github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples/config"
1206+
"github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go/models"
1207+
)
1208+
1209+
func ConvertToPng() {
1210+
1211+
settings := models.ConvertSettings{
1212+
Format: "png",
1213+
FilePath: "WordProcessing/four-pages.docx",
1214+
OutputPath: "converted",
1215+
ConvertOptions: &models.PngConvertOptions{
1216+
FromPage: 1,
1217+
PagesCount: 2,
1218+
BackgroundColor: "white",
1219+
},
1220+
}
1221+
1222+
result, _, err := config.Client.ConvertApi.ConvertDocument(config.Ctx, settings)
1223+
1224+
if err != nil {
1225+
fmt.Printf("ConvertToPng error: %v\n", err)
1226+
return
1227+
}
1228+
1229+
fmt.Printf("Document converted successfully: %v\n", result[0].Url)
1230+
}
1231+
```
1232+
1233+
{{< /tab >}} {{< /tabs >}}

‎content/conversion/developer-guide/data-structures/convertoptions.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ toc: True
9595
|verticalResolution|Desired image vertical resolution after conversion.
9696
|grayscale|Convert to grayscale image
9797
|rotateAngle|Image conversion angle
98+
|backgroundColor|Background color of the image after conversion (default is transparent)
9899
|fromPage|Start conversion from specified page number
99100
|pagesCount|Convert pagesCount from specified page
100101
|pages|An array with set of pages to be converted
@@ -110,6 +111,7 @@ toc: True
110111
"verticalResolution": 72,
111112
"grayscale": false,
112113
"rotateAngle": 0,
114+
"backgroundColor": "white",
113115
"fromPage": 1,
114116
"pagesCount": 10,
115117
"pages": [2,4,6],
@@ -130,6 +132,7 @@ toc: True
130132
|quality|Desired image quality when converting to Jpeg
131133
|grayscale|Convert to grayscale image
132134
|rotateAngle|Image conversion angle
135+
|backgroundColor|Background color of the image after conversion (default is transparent)
133136
|fromPage|Start conversion from specified page number
134137
|pagesCount|Convert pagesCount from specified page
135138
|pages|An array with set of pages to be converted
@@ -146,6 +149,7 @@ toc: True
146149
"quality": 95,
147150
"grayscale": false,
148151
"rotateAngle": 0,
152+
"backgroundColor": "white",
149153
"fromPage": 1,
150154
"pagesCount": 10,
151155
"pages": [2,4,6],
@@ -166,6 +170,7 @@ toc: True
166170
|compression|Tiff compression
167171
|grayscale|Convert to grayscale image
168172
|rotateAngle|Image conversion angle
173+
|backgroundColor|Background color of the image after conversion (default is transparent)
169174
|fromPage|Start conversion from specified page number
170175
|pagesCount|Convert pagesCount from specified page
171176
|pages|An array with set of pages to be converted
@@ -182,6 +187,7 @@ toc: True
182187
"compression": "lzw",
183188
"grayscale": false,
184189
"rotateAngle": 0,
190+
"backgroundColor": "white",
185191
"fromPage": 1,
186192
"pagesCount": 10,
187193
"pages": [2,4,6],

0 commit comments

Comments
 (0)