Aspose.SVG for .NET

https://reference.aspose.com/svg/
Admin
Aspose.SVG for .NET is a cross-platform library for processing, rendering, and converting SVG...
Tokens:2,112,402
Snippets:18,137
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### RenderingOptions.PageSetup Property

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/renderingoptions/pagesetup

Gets a page setup object used for configuring the output page.

```APIDOC
## RenderingOptions.PageSetup Property

### Description
Gets a page setup object is used for configuration output page-set.

### Method
Property (Get)

### Endpoint
N/A (Class Property)

### Parameters
N/A

### Request Body
N/A

### Response
#### Success Response (200)
- **PageSetup** (PageSetup) - The page setup object for output configuration.

#### Response Example
```csharp
public PageSetup PageSetup { get; }
```

### See Also
- class PageSetup
- class RenderingOptions
- namespace Aspose.Svg.Rendering
- assembly Aspose.SVG
```

--------------------------------

### Page Setup Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/renderingoptions/page_setup

Gets a page setup object used for configuring the output page settings.

```APIDOC
## page_setup property

### Description
Gets a page setup object is used for configuration output page-set.

### Definition:
```python
@property
def page_setup(self):
    ...
```

### See Also
  * module `aspose.svg.rendering`
  * class `PageSetup`
  * class `RenderingOptions`
```

--------------------------------

### Get Rendering Options

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device-2/options

Use this property to access the rendering options for a device. No setup or imports are required beyond having an instance of the Device class.

```csharp
public TRenderingOptions Options { get; }
```

--------------------------------

### ImageSaveOptions PageSetup Property

Source: https://reference.aspose.com/svg/net/aspose.svg.saving/imagesaveoptions

Gets a page setup object used for configuring output page-set.

```csharp
PageSetup { get; }
```

--------------------------------

### Access PageSetup Property

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/renderingoptions/pagesetup

Gets a page setup object used for configuring output page settings. This property is part of the RenderingOptions class.

```csharp
public PageSetup PageSetup { get; }
```

--------------------------------

### Page Setup Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.saving/pdfsaveoptions/page_setup

Retrieves a page setup object used for configuring the output page settings.

```APIDOC
## page_setup Property

### Description
Gets a page setup object is used for configuration output page-set.

### Definition:
```python
@property
def page_setup(self):
    ...
```

### See Also
  * module `aspose.svg.saving`
  * class `PageSetup`
  * class `PdfSaveOptions`
```

--------------------------------

### Page Setup Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.skia/skiacanvasrenderingoptions/page_setup

Retrieves or sets a page setup object used for configuring the output page settings.

```APIDOC
## page_setup property

### Description
Gets a page setup object is used for configuration output page-set.

### Definition:
```python
@property
def page_setup(self):
    ...
```

### See Also
  * module `aspose.svg.rendering.skia`
  * class `PageSetup`
  * class `SkiaCanvasRenderingOptions`
```

--------------------------------

### XpsDevice Constructor with Options and File Path

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/__init__

Initializes a new instance of the XpsDevice class with rendering options and an output file name.

```APIDOC
## XpsDevice Constructor (Options, File Path)

### Description
Initializes a new instance of the `XpsDevice` class by specifying rendering options and the output file name.

### Method
`__init__`

### Parameters
#### Path Parameters
- **options** (`XpsRenderingOptions`) - Required - Rendering options.
- **file** (str) - Required - The output file name.

### Request Example
```python
# This is a conceptual example, actual implementation may vary.
from aspose.svg.rendering.xps import XpsDevice, XpsRenderingOptions

# Assume options is an instance of XpsRenderingOptions
# output_file = "output.xps"
# options = XpsRenderingOptions()
# xps_device = XpsDevice(options, output_file)
```

### Response
#### Success Response (200)
- **None** - This is a constructor, it does not return a value.

#### Response Example
```json
// No direct response body for a constructor.
```
```

--------------------------------

### Get MouseEvent ClientY Coordinate

Source: https://reference.aspose.com/svg/net/aspose.svg.dom.events/mouseevent/clienty

Use this property to get the vertical coordinate of a mouse event relative to the viewport. No specific setup is required beyond having a MouseEvent object.

```csharp
public long ClientY { get; }
```

--------------------------------

### Begin Rendering a Document with IDevice.BeginDocument

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/idevice/begindocument

Call this method to start the rendering process for a given document. Ensure a Document object is provided as a parameter.

```csharp
public void BeginDocument(Document document)
```

--------------------------------

### Begin Document Rendering

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device-2/begindocument

Call this method to start the rendering process for a given document. Ensure a Document object is provided.

```csharp
public virtual void BeginDocument(Document document)
```

--------------------------------

### Get and Set Url Username

Source: https://reference.aspose.com/svg/python-net/aspose.svg/url/username

Use this property to get or set the string representation for the specified URL username. No specific setup or imports are required beyond having the Url class available.

```python
Copy@property
def username(self):
    ...
@username.setter
def username(self, value):
    ...
```

--------------------------------

### Initialize ImageDevice with Options and File Path

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.image/imagedevice/__init__

Initialize ImageDevice with rendering options and specify the output file path. This allows for customized image generation to a file.

```python
def __init__(self, options, file):
    ...
```

--------------------------------

### PageSetup.Sizing Property

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/pagesetup/sizing

Provides information on how to get or set the sizing type for page setup in Aspose.SVG.

```APIDOC
## PageSetup.Sizing Property

### Description
Gets or sets the sizing type.

### Method
Property (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
N/A

### Request Body
N/A

### Response
#### Success Response (200)
- **Sizing** (SizingType) - The current sizing type.

#### Response Example
```csharp
public SizingType Sizing { get; set; }
```

### See Also
- enum SizingType
- class PageSetup
- namespace Aspose.Svg.Rendering
- assembly Aspose.SVG
```

--------------------------------

### XpsDevice Constructor with Options and Stream

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/__init__

Initializes a new instance of the XpsDevice class with rendering options and an output stream.

```APIDOC
## XpsDevice Constructor (Options, Stream)

### Description
Initializes a new instance of the `XpsDevice` class by specifying rendering options and the output stream.

### Method
`__init__`

### Parameters
#### Path Parameters
- **options** (`XpsRenderingOptions`) - Required - Rendering options.
- **stream** (io.RawIOBase) - Required - The output stream.

### Request Example
```python
# This is a conceptual example, actual implementation may vary.
import io
from aspose.svg.rendering.xps import XpsDevice, XpsRenderingOptions

# Assume options is an instance of XpsRenderingOptions
# output_stream = io.BytesIO()
# options = XpsRenderingOptions()
# xps_device = XpsDevice(options, output_stream)
```

### Response
#### Success Response (200)
- **None** - This is a constructor, it does not return a value.

#### Response Example
```json
// No direct response body for a constructor.
```
```

--------------------------------

### Setting Metered Keys

Source: https://reference.aspose.com/svg/net/aspose.svg/metered

Examples demonstrating how to set the metered public and private keys.

```APIDOC
## Examples

In this example, an attempt will be made to set metered public and private key.

### C#
```csharp
Metered matered = new Metered();
matered.SetMeteredKey("PublicKey", "PrivateKey");
```

### Visual Basic
```vb
Dim matered As Metered = New Metered
matered.SetMeteredKey("PublicKey", "PrivateKey")
```

### Java
```java
Metered matered = new Metered();
matered.setMeteredKey("PublicKey", "PrivateKey");
```
```

--------------------------------

### Rect Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.drawing/ilineargradientbrush/rect

Gets or sets the rectangular region that defines the starting and ending points of the gradient.

```APIDOC
## rect property

### Description
Gets or sets the rectangular region that defines the starting and ending points of the gradient.

### Definition:
```python
@property
def rect(self):
    ...
@rect.setter
def rect(self, value):
    ...
```

### See Also
  * module `aspose.svg.drawing`
  * class `ILinearGradientBrush`
```

--------------------------------

### page_setup Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.skia/skiacanvasrenderingoptions/horizontal_resolution

Documentation for the page_setup property.

```APIDOC
## page_setup Property

### Description
This property is related to the page setup configuration within Aspose.SVG.

### Details
Further details about the `page_setup` property are not provided in the source text.
```

--------------------------------

### ILinearGradientBrush.Rect Property

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/ilineargradientbrush/rect

Gets or sets the rectangular region that defines the starting and ending points of the gradient for ILinearGradientBrush.

```APIDOC
## ILinearGradientBrush.Rect Property

### Description
Gets or sets the rectangular region that defines the starting and ending points of the gradient.

### Method
Property (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
N/A

### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Rect** (RectangleF) - The rectangular region defining the gradient’s start and end points.

#### Response Example
```csharp
public RectangleF Rect { get; set; }
```

### See Also
- interface ILinearGradientBrush
- namespace Aspose.Svg.Drawing
- assembly Aspose.SVG
```

--------------------------------

### Get height property

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgmaskelement/height

Retrieves the value of the 'height' attribute from a 'mask' element. Requires setup with Aspose.SVG library.

```python
def height(self):
    ...
```

--------------------------------

### XpsDevice.begin_page

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/begin_page

Initializes a new page on the XPS device with the specified size. This method is part of the XPS rendering process.

```APIDOC
## begin_page

### Description
Initializes a new page on the XPS device with the specified size.

### Method
`begin_page(self, size)`

### Parameters
#### Path Parameters
- **size** (aspose.pydrawing.SizeF) - Required - The size of the page to be created.

### See Also
- module `aspose.svg.rendering.xps`
- class `XpsDevice`
```

--------------------------------

### Initialize Page with Size and Margin

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/page/page

Use this constructor to create a new Page instance with specified page dimensions and margin settings. Requires both Size and Margin objects.

```csharp
public Page(Size size, Margin margin)
```

--------------------------------

### Get or Set Rect Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.drawing/ilineargradientbrush/rect

This property defines the rectangular region for gradient start and end points. It is part of the ILinearGradientBrush interface.

```python
Copy@property
def rect(self):
    ...
@rect.setter
def rect(self, value):
    ...
```

--------------------------------

### Page Setup API

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/pagesetup/left_page

This section details the `left_page` property, which is used to get the Odd Page configuration within the Aspose.SVG rendering context.

```APIDOC
## GET /api/svg/pagesetup/left_page

### Description
Gets the Odd Page configuration.

### Method
GET

### Endpoint
/api/svg/pagesetup/left_page

### Parameters
#### Query Parameters
- **page_setup_id** (string) - Required - The ID of the PageSetup object.

### Response
#### Success Response (200)
- **page_setup_config** (object) - The configuration for the odd page.
  - **margin_left** (number) - The left margin value.
  - **margin_right** (number) - The right margin value.
  - **margin_top** (number) - The top margin value.
  - **margin_bottom** (number) - The bottom margin value.

#### Response Example
```json
{
  "page_setup_config": {
    "margin_left": 10,
    "margin_right": 10,
    "margin_top": 5,
    "margin_bottom": 5
  }
}
```
```

--------------------------------

### Begin Document - Aspose.SVG

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/begin_document

Initializes a new document for rendering. This method is part of the XPS rendering device.

```python
def begin_document(self, document):
    ...

```

--------------------------------

### Get Unit Value

Source: https://reference.aspose.com/svg/python-net/aspose.svg.drawing/angle/get_value

Use this method to retrieve the object's unit value. No specific setup is required beyond having an instance of the object.

```python
def get_value(self):
    ...
```

--------------------------------

### Set Metered License Keys (Java)

Source: https://reference.aspose.com/svg/net/aspose.svg/metered

This example demonstrates setting the metered public and private keys for Java applications. Ensure this is called upon application startup for metered licensing.

```java
Metered matered = new Metered();
matered.setMeteredKey("PublicKey", "PrivateKey");
```

--------------------------------

### IDevice.BeginPage Method

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/idevice/beginpage

Begins rendering of a new page with a specified size.

```APIDOC
## IDevice.BeginPage Method

### Description
Begins rendering of the new page.

### Method
`public void BeginPage(SizeF size)`

### Parameters
#### Path Parameters
- **size** (SizeF) - Required - Size of the page.

### See Also
- interface IDevice
- namespace Aspose.Svg.Rendering
- assembly Aspose.SVG
```

--------------------------------

### Create Configuration Instance

Source: https://reference.aspose.com/svg/net/aspose.svg/configuration

Static method to create and configure an instance of the Configuration object. Use this to set up application environment settings.

```csharp
static Create()
Create and configure the instance of Configuration object.
```

```csharp
static Create(_Action <IConfigurationBuilder>_)
Create and configure the instance of Configuration object.
```

--------------------------------

### Get and Set hostname Property in Aspose.SVG

Source: https://reference.aspose.com/svg/python-net/aspose.svg/url/hostname

This snippet demonstrates how to get or set the string representation of a URL's hostname using the hostname property of the Url class. No specific setup or imports are shown, implying it's part of a larger class context.

```python
Copy@property
def hostname(self):
    ...
@hostname.setter
def hostname(self, value):
    ...
```

--------------------------------

### XpsDevice Constructor with File Path

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/__init__

Initializes a new instance of the XpsDevice class using an output file name.

```APIDOC
## XpsDevice Constructor (File Path)

### Description
Initializes a new instance of the `XpsDevice` class using the specified output file name.

### Method
`__init__`

### Parameters
#### Path Parameters
- **file** (str) - Required - The output file name.

### Request Example
```python
# This is a conceptual example, actual implementation may vary.
from aspose.svg.rendering.xps import XpsDevice

# output_file = "output.xps"
# xps_device = XpsDevice(output_file)
```

### Response
#### Success Response (200)
- **None** - This is a constructor, it does not return a value.

#### Response Example
```json
// No direct response body for a constructor.
```
```

--------------------------------

### XpsDevice Constructor with Options and Stream Provider

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/__init__

Initializes a new instance of the XpsDevice class with rendering options and a stream provider.

```APIDOC
## XpsDevice Constructor (Options, Stream Provider)

### Description
Initializes a new instance of the `XpsDevice` class by specifying rendering options and a stream provider.

### Method
`__init__`

### Parameters
#### Path Parameters
- **options** (`XpsRenderingOptions`) - Required - Rendering options.
- **stream_provider** (aspose.svg.io.ICreateStreamProvider) - Required - Object that implements the `ICreateStreamProvider` interface.

### Request Example
```python
# This is a conceptual example, actual implementation may vary.
from aspose.svg.rendering.xps import XpsDevice, XpsRenderingOptions
from aspose.svg.io import ICreateStreamProvider

# Assume options is an instance of XpsRenderingOptions
# Assume stream_provider is an instance of a class implementing ICreateStreamProvider
# options = XpsRenderingOptions()
# stream_provider = YourStreamProviderImplementation()
# xps_device = XpsDevice(options, stream_provider)
```

### Response
#### Success Response (200)
- **None** - This is a constructor, it does not return a value.

#### Response Example
```json
// No direct response body for a constructor.
```
```

--------------------------------

### Declare Document.OnPlaying Event Handler

Source: https://reference.aspose.com/svg/net/aspose.svg.dom/document/onplaying

Gets or sets the event handler for the OnPlaying event. This event is typically triggered when media playback starts or resumes.

```csharp
public event DOMEventHandler OnPlaying;
```

--------------------------------

### Initialize SVGFESpotLightElementBuilder

Source: https://reference.aspose.com/svg/net/aspose.svg.builder/svgfespotlightelementbuilder/svgfespotlightelementbuilder

Use the default constructor to create a new instance of the SVGFESpotLightElementBuilder class. No specific setup is required.

```csharp
Copypublic SVGFESpotLightElementBuilder()


```

--------------------------------

### SVGTextPathElement.StartOffset Property

Source: https://reference.aspose.com/svg/net/aspose.svg/svgtextpathelement/spacing

Corresponds to the 'startOffset' attribute on the given 'textPath' element. This property allows you to get or set the starting offset of the text along the path.

```APIDOC
## GET /websites/reference_aspose_svg/SVGTextPathElement/StartOffset

### Description
Retrieves the value of the 'startOffset' attribute from a textPath element.

### Method
GET

### Endpoint
/websites/reference_aspose_svg/SVGTextPathElement/StartOffset

### Parameters
None

### Response
#### Success Response (200)
- **startOffset** (string) - The value of the 'startOffset' attribute.

#### Response Example
```json
{
  "startOffset": "10%"
}
```

## SET /websites/reference_aspose_svg/SVGTextPathElement/StartOffset

### Description
Sets the value of the 'startOffset' attribute on a textPath element.

### Method
SET

### Endpoint
/websites/reference_aspose_svg/SVGTextPathElement/StartOffset

### Parameters
#### Request Body
- **startOffset** (string) - Required - The desired start offset value (e.g., "50", "25px", "10%").

### Request Example
```json
{
  "startOffset": "20px"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "StartOffset attribute updated successfully."
}
```
```

--------------------------------

### Device Constructor

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device/device

Initializes a new instance of the Device class.

```APIDOC
## Device constructor

### Description
Initializes a new instance of the `Device` class.

### Method
`Device()`

### Endpoint
N/A (Class Constructor)

### Parameters
None

### Request Example
```csharp
// Example of how to use the Device constructor
Device device = new Device();
```

### Response
N/A (Constructor does not return a value in the typical API sense)

### See Also
* class Device
* namespace Aspose.Svg.Rendering
* assembly Aspose.SVG
```

--------------------------------

### Get SVGDocument Character Set

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgdocument/character_set

Access the character_set property to retrieve the encoding of an SVG document. No specific setup or imports are required beyond having an SVGDocument instance.

```python
Copy@property
def character_set(self):
    ...
```

--------------------------------

### Get Numeric Unit Value

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/numeric/getvalue

Retrieves the raw double value of the numeric object. No specific setup or imports are required beyond having an instance of the Numeric class.

```csharp
public double GetValue()
```

--------------------------------

### Initialize ImageDevice with File Path

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.image/imagedevice/__init__

Use this constructor to initialize ImageDevice for direct output to a file. Provide the output file name as a string.

```python
def __init__(self, file):
    ...
```

--------------------------------

### FileSystemResourceHandler Constructor (output_url)

Source: https://reference.aspose.com/svg/python-net/aspose.svg.saving.resourcehandlers/filesystemresourcehandler/__init__

Initializes a new instance of the FileSystemResourceHandler class with a specified output URL.

```APIDOC
## FileSystemResourceHandler constructor (output_url)

### Description
Initializes a new instance of the `FileSystemResourceHandler` class.

### Method
`__init__`

### Parameters
#### Path Parameters
- **output_url** (Url) - Required - A URL indicating where the resources will be saved.

### Request Example
```python
# No request body for constructor
```

### Response
#### Success Response (200)
- **None** - Initializes the object.

#### Response Example
```json
{
  "message": "FileSystemResourceHandler initialized successfully"
}
```
```

--------------------------------

### Get Hexadecimal Color String

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/color/torgbhexstring

Use this method to convert a color object to its hexadecimal string representation. No specific setup is required beyond having a Color object.

```csharp
public string ToRgbHexString()
```

--------------------------------

### begin_page Method

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/idevice/begin_page

Begins the rendering of a new page with a specified size.

```APIDOC
## begin_page

### Description
Begins rendering of the new page.

### Method
```python
def begin_page(self, size):
    ...
```

### Parameters
#### Path Parameters
- **size** (aspose.pydrawing.SizeF) - Required - Size of the page.

### See Also
- module `aspose.svg.rendering`
- class `IDevice`
```

--------------------------------

### Document.OnLoadStart Event Handler

Source: https://reference.aspose.com/svg/net/aspose.svg.dom/document/onloadstart

Gets or sets the event handler for the OnLoadStart event. This event is typically used to perform actions just before the SVG document starts loading.

```csharp
public event DOMEventHandler OnLoadStart;
```

--------------------------------

### Get Page Setup Object - Aspose.SVG

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/renderingoptions/page_setup

Accesses the page_setup property to retrieve a PageSetup object for configuring output page settings. This property is part of the rendering options.

```python
Copy@property
def page_setup(self):
    ...
```

--------------------------------

### Initialize Device Class Instance

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device/device

Use this constructor to create a new instance of the Device class. No specific setup or imports are required beyond having the Aspose.SVG library included in your project.

```csharp
public Device()
```

--------------------------------

### Get Font Families Collection

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering.fonts/fontmatchingproperties/fontfamilies

Use this property to access the collection of font families available for matching. No specific setup or imports are required beyond having an instance of FontMatchingProperties.

```csharp
public IEnumerable<string> FontFamilies { get; }
```

--------------------------------

### Element Initialization

Source: https://reference.aspose.com/svg/python-net/aspose.svg.dom/element/__init__

Explains how to initialize a new instance of the Element class. Direct instantiation is discouraged; use Document.create_element or Document.create_element_ns instead.

```APIDOC
## Element.init

### Description
Initializes a new instance of the `Element` class. Don’t call this constructor directly, use `Document.create_element` or `Document.create_element_ns`.

### Method
`__init__`

### Parameters
#### Parameters
- **qualified_name** (`QualifiedName`) - The qualified name.
- **document** (`Document`) - The associated document.

### See Also
- module `aspose.svg.dom`
- class `Element`
```

--------------------------------

### Document.OnPlay Event Handler - Aspose.SVG

Source: https://reference.aspose.com/svg/net/aspose.svg.dom/document/onplay

Gets or sets the event handler for the OnPlay event. This is typically used to attach custom logic that should execute when the media playback starts.

```csharp
public event DOMEventHandler OnPlay;
```

--------------------------------

### Get Current SVG Time

Source: https://reference.aspose.com/svg/net/aspose.svg/svgsvgelement/getcurrenttime

Use this method to retrieve the current time in seconds for an SVG document fragment. Returns 0 if the document timeline has not yet started.

```csharp
public float GetCurrentTime()
```

--------------------------------

### Begin Rendering a New Page

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/idevice/begin_page

Initiates the rendering process for a new page. Requires the size of the page as a parameter.

```python
def begin_page(self, size):
    ...
```

--------------------------------

### SVGTextPathElement.StartOffset Property

Source: https://reference.aspose.com/svg/net/aspose.svg/svgtextpathelement/startoffset

The StartOffset property of the SVGTextPathElement class allows you to get or set the 'startOffset' attribute of a 'textPath' element. This attribute defines the starting position of the text along the path.

```APIDOC
## SVGTextPathElement.StartOffset Property

### Description
Corresponds to attribute ‘startOffset’ on the given ‘textPath’ element.

### Property Value
The attribute ‘startOffset’ of the given ‘textPath’ element.

### See Also
* class SVGAnimatedLength
* class SVGTextPathElement
* namespace Aspose.Svg
* assembly Aspose.SVG
```

--------------------------------

### Initialize ImageDevice with Options and Stream Provider

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.image/imagedevice/__init__

Initialize ImageDevice with specific rendering options and a custom stream provider for advanced control over the output. Requires an ImageRenderingOptions object and an ICreateStreamProvider.

```python
def __init__(self, options, stream_provider):
    ...
```

--------------------------------

### Get width property of SVGAnimatedLength

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgfilterelement/width

Accesses the width property of an SVGAnimatedLength object, which represents the 'width' attribute of a 'filter' element. No specific setup or imports are required beyond having an instance of SVGFilterElement.

```python
@property
def width(self):
    ...
```

--------------------------------

### FileSystemResourceHandler Constructor (output_path)

Source: https://reference.aspose.com/svg/python-net/aspose.svg.saving.resourcehandlers/filesystemresourcehandler/__init__

Initializes a new instance of the FileSystemResourceHandler class with a specified output path.

```APIDOC
## FileSystemResourceHandler constructor (output_path)

### Description
Initializes a new instance of the `FileSystemResourceHandler` class.

### Method
`__init__`

### Parameters
#### Path Parameters
- **output_path** (str) - Required - A path indicating where the resources will be saved.

### Request Example
```python
# No request body for constructor
```

### Response
#### Success Response (200)
- **None** - Initializes the object.

#### Response Example
```json
{
  "message": "FileSystemResourceHandler initialized successfully"
}
```
```

--------------------------------

### Get Document Title Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgdocument/title

Accesses the 'title' property of an SVG document, which corresponds to the 'title' sub-element of the 'svg' root element. No specific setup is required beyond having an SVGDocument instance.

```python
def title(self):
    ...
```

--------------------------------

### Get RGB String Representation of Color

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/color/torgbstring

Use this method to obtain a string representation of a color in the format 'rgb(R, G, B)'. No specific setup is required beyond having a Color object.

```csharp
public string ToRgbString()
```

--------------------------------

### Get Current Time in SVG Document

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgsvgelement/get_current_time

Returns the current time in seconds relative to the start time for the current SVG document fragment. Returns 0 if the document timeline has not yet begun.

```python
def get_current_time(self):
    ...
```

--------------------------------

### XpsDevice Constructors

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering.xps/xpsdevice/xpsdevice

This section outlines the different ways to initialize an XpsDevice object, allowing for flexibility in specifying output streams, files, and rendering options.

```APIDOC
## XpsDevice Constructors

This section details the various constructors for the `XpsDevice` class, used for rendering SVG content to XPS format.

### XpsDevice(ICreateStreamProvider streamProvider)

Initializes a new instance of the `XpsDevice` class.

**Parameters**
- **streamProvider** (ICreateStreamProvider) - Required - The stream provider.

### XpsDevice(XpsRenderingOptions options, ICreateStreamProvider streamProvider)

Initializes a new instance of the `XpsDevice` class by rendering options and stream provider.

**Parameters**
- **options** (XpsRenderingOptions) - Required - Rendering options.
- **streamProvider** (ICreateStreamProvider) - Required - Object that implements the `ICreateStreamProvider` interface.

### XpsDevice(string file)

Initializes a new instance of the `XpsDevice` class.

**Parameters**
- **file** (String) - Required - The output file name.

### XpsDevice(XpsRenderingOptions options, string file)

Initializes a new instance of the `XpsDevice` class by rendering options and output file name.

**Parameters**
- **options** (XpsRenderingOptions) - Required - Rendering options.
- **file** (String) - Required - The output file name.

### XpsDevice(Stream stream)

Initializes a new instance of the `XpsDevice` class.

**Parameters**
- **stream** (Stream) - Required - The stream.

### XpsDevice(XpsRenderingOptions options, Stream stream)

Initializes a new instance of the `XpsDevice` class by rendering options and output stream.

**Parameters**
- **options** (XpsRenderingOptions) - Required - Rendering options.
- **stream** (Stream) - Required - The output stream.
```

--------------------------------

### Get Point at Specific Length on Path

Source: https://reference.aspose.com/svg/python-net/aspose.svg/svgcircleelement/get_point_at_length

Use this method to find the (x,y) coordinate along an SVG path at a given distance from its start. The distance is measured in the current user coordinate system.

```python
def get_point_at_length(self, distance):
    ...
```

--------------------------------

### XpsDevice Constructor with Stream

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.xps/xpsdevice/__init__

Initializes a new instance of the XpsDevice class using an output stream.

```APIDOC
## XpsDevice Constructor (Stream)

### Description
Initializes a new instance of the `XpsDevice` class using the specified output stream.

### Method
`__init__`

### Parameters
#### Path Parameters
- **stream** (io.RawIOBase) - Required - The output stream.

### Request Example
```python
# This is a conceptual example, actual implementation may vary.
import io
from aspose.svg.rendering.xps import XpsDevice

# output_stream = io.BytesIO()
# xps_device = XpsDevice(output_stream)
```

### Response
#### Success Response (200)
- **None** - This is a constructor, it does not return a value.

#### Response Example
```json
// No direct response body for a constructor.
```
```

--------------------------------

### Initialize License Object

Source: https://reference.aspose.com/svg/net/aspose.svg/license/license

Initializes a new instance of the License class. No setup is required before calling this.

```csharp
public License()
```

--------------------------------

### Get or Set Gradient Rectangular Region

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/ilineargradientbrush/rect

Use this property to define the rectangular region that specifies the start and end points for a linear gradient. This is essential for controlling the direction and extent of the gradient fill.

```csharp
public RectangleF Rect { get; set; }
```

--------------------------------

### Get Total Path Length - C#

Source: https://reference.aspose.com/svg/net/aspose.svg/svggeometryelement/gettotallength

Use this method to retrieve the total length of an SVG path in the current user coordinate system. No specific setup or imports are required beyond having an instance of SVGGeometryElement.

```csharp
public float GetTotalLength()
```

--------------------------------

### Instantiate DeviceConfiguration - C#

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device-2.deviceconfiguration-2/deviceconfiguration

Use the default constructor to create a new instance of DeviceConfiguration. No specific setup is required beyond having the Aspose.SVG library referenced.

```csharp
public DeviceConfiguration()
```

--------------------------------

### Get Odd Page Configuration

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/pagesetup/leftpage

Use this property to access the configuration settings specific to odd-numbered pages within a document's page setup. This is useful for applying different formatting to odd and even pages.

```csharp
public Page LeftPage { get; }
```

--------------------------------

### Initialize Configuration

Source: https://reference.aspose.com/svg/net/aspose.svg/configuration/configuration

Initializes a new instance of the Configuration class. This is the default constructor.

```csharp
public Configuration()
```

--------------------------------

### Convert Color to RGBA Hex String

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/color/torgbahexstring

Use this method to get a hexadecimal string representation of a color, including its alpha component, in the #RRGGBBAA format. No specific setup is required beyond having an instance of the Color class.

```csharp
public string ToRgbaHexString()
```

--------------------------------

### Get RGBA Color String Representation

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/color/torgbastring

Use this method to obtain a string representation of a color in the RGBA format (rgba(R, G, B, A)). No specific setup or imports are required beyond having a Color object.

```csharp
public string ToRgbaString()
```

--------------------------------

### Initialize Method

Source: https://reference.aspose.com/svg/python-net/aspose.svg.datatypes/svgstringlist/initialize

Initializes a new instance of a class with the provided item.

```APIDOC
## initialize

### Description
Initializes a new instance of a class.

### Method
initialize

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### See Also
* module `aspose.svg.datatypes`
* class `SVGStringList`
```

--------------------------------

### Metered License Key Setup

Source: https://reference.aspose.com/svg/python-net/aspose.svg/metered/set_metered_key

This method is used to set the metered public and private keys. It's essential to call this API when starting an application with a metered license. Regular calls are recommended to prevent the license from reverting to evaluation status due to failed consumption data uploads.

```APIDOC
## set_metered_key

### Description
Sets metered public and private key. If you purchase metered license, when start application, this API should be called, normally, this is enough. However, if always fail to upload consumption data and exceed 24 hours, the license will be set to evaluation status, to avoid such case, you should regularly check the license status, if it is evaluation status, call this API again.

### Method
```python
def set_metered_key(self, public_key, private_key):
    ...
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
Parameter| Type| Description  
---|---|---  
public_key| str| public key  
private_key| str| private key  

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### See Also
  * module `aspose.svg`
  * class `Metered`
```

--------------------------------

### Initialize SVGFEPointLightElementBuilder

Source: https://reference.aspose.com/svg/net/aspose.svg.builder/svgfepointlightelementbuilder/svgfepointlightelementbuilder

Use the default constructor to create a new instance of the SVGFEPointLightElementBuilder class. No specific setup is required.

```csharp
public SVGFEPointLightElementBuilder()
```

--------------------------------

### License Initialization

Source: https://reference.aspose.com/svg/python-net/aspose.svg/license/__init__

Initializes a new instance of the License class. This is the first step before applying a license.

```APIDOC
## License Constructor

### Description
Initializes a new instance of this class.

### Method
`__init__`

### Endpoint
N/A (Class Constructor)

### Parameters
None

### Request Example
```python
license = License()
```

### Response
N/A (Constructor does not return a value)

### See Also
* module `aspose.svg`
* class `License`
```

--------------------------------

### time_stamp property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.dom.events/focusevent/time_stamp

Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

```APIDOC
## time_stamp property

### Description
Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

### Definition:
```python
@property
def time_stamp(self):
    ...
```

### See Also
  * module `aspose.svg.dom.events`
  * class `FocusEvent`
```

--------------------------------

### Initialize FileSystemResourceHandler with Output URL

Source: https://reference.aspose.com/svg/python-net/aspose.svg.saving.resourcehandlers/filesystemresourcehandler/__init__

Initializes a new instance of the FileSystemResourceHandler class using a URL to specify where resources will be saved. Ensure the Url type is correctly instantiated.

```python
def __init__(self, output_url):
    ...

```

--------------------------------

### GET Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.net/httpmethod/get

Represents an HTTP GET protocol method for retrieving properties.

```APIDOC
## GET /property

### Description
Represents an HTTP GET protocol method for retrieving properties.

### Method
GET

### Endpoint
/property

### See Also
* module `aspose.svg.net`
* class `HttpMethod`
```

--------------------------------

### Get or Set Length

Source: https://reference.aspose.com/svg/net/aspose.svg.drawing/lengthorauto

Gets or sets the length value for the LengthOrAuto instance.

```csharp
Length { get; set; }
```

--------------------------------

### Initialize StencilConfiguration

Source: https://reference.aspose.com/svg/net/aspose.svg.imagevectorization/stencilconfiguration/stencilconfiguration

Use this constructor to create a new instance of the StencilConfiguration class. No specific setup or constraints are mentioned.

```csharp
public StencilConfiguration()
```

--------------------------------

### Get CounterIncrement Property

Source: https://reference.aspose.com/svg/net/aspose.svg.dom.css/icss2properties/counterincrement

Represents the counter-increment property. Use this to get or set the counter-increment property value.

```csharp
public string CounterIncrement { get; set; }
```

--------------------------------

### Initialize ImageDevice with Options and Stream

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.image/imagedevice/__init__

Initialize ImageDevice with rendering options and an output stream. This is useful for writing image data to memory or other custom stream destinations.

```python
def __init__(self, options, stream):
    ...
```

--------------------------------

### Get or Set BorderSpacing Property

Source: https://reference.aspose.com/svg/net/aspose.svg.dom.css/icss2properties/borderspacing

Represents the border-spacing property. Use this to get or set the spacing between borders.

```csharp
public string BorderSpacing { get; set; }
```

--------------------------------

### Initialize SVGAnimateMotionElementBuilder

Source: https://reference.aspose.com/svg/net/aspose.svg.builder/svganimatemotionelementbuilder/svganimatemotionelementbuilder

Use the default constructor to create a new instance of the SVGAnimateMotionElementBuilder class. No specific setup or imports are required beyond having the Aspose.SVG library available.

```csharp
public SVGAnimateMotionElementBuilder()
```

--------------------------------

### Configuration.Create()

Source: https://reference.aspose.com/svg/net/aspose.svg/configuration/create

Creates and configures an instance of the Configuration object.

```APIDOC
## Create()

### Description
Create and configure the instance of Configuration object.

### Method
`public static Configuration Create()`

### Return Value
The instance of Configuration object.

### See Also
* class Configuration
* namespace Aspose.Svg
* assembly Aspose.SVG
```

--------------------------------

### Get or Set BorderStyle

Source: https://reference.aspose.com/svg/net/aspose.svg.dom.css/icss2properties/borderstyle

Represents the border-style property. Use this to get or set the border style of an element.

```csharp
public string BorderStyle { get; set; }
```

--------------------------------

### Configuration Constructor

Source: https://reference.aspose.com/svg/net/aspose.svg/configuration/configuration

Initializes a new instance of the Configuration class.

```APIDOC
## Configuration Constructor

### Description
Initializes a new instance of the `Configuration` class.

### Method
`Configuration()`

### Endpoint
N/A (Class Constructor)

### Parameters
None

### Request Example
```csharp
// Example of instantiating the Configuration class
var config = new Aspose.Svg.Configuration();
```

### Response
N/A (Constructor does not return a value in the typical API sense)

### See Also
* class `Configuration`
* namespace `Aspose.Svg`
* assembly `Aspose.SVG`
```

--------------------------------

### Get and Set BorderTopColor

Source: https://reference.aspose.com/svg/net/aspose.svg.dom.css/icss2properties/bordertopcolor

Represents the border-top-color property. Use this to get or set the color of the top border.

```csharp
public string BorderTopColor { get; set; }
```

--------------------------------

### PageSetup.FirstPage Property

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/pagesetup/firstpage

Gets or sets the first page configuration.

```APIDOC
## PageSetup.FirstPage Property

### Description
Gets or sets the first page configuration.

### Property Value
The first page.

### See Also
* class Page
* class PageSetup
* namespace Aspose.Svg.Rendering
* assembly Aspose.SVG
```

--------------------------------

### Get and Set window_size Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.services/ideviceinformationservice/window_size

Use this property to get or set the size of the window. It is part of the IDeviceInformationService in Aspose.SVG.

```python
Copy@property
def window_size(self):
    ...
@window_size.setter
def window_size(self, value):
    ...
```

--------------------------------

### Initialize SVGOptimizationOptions

Source: https://reference.aspose.com/svg/net/aspose.svg.toolkit.optimizers/svgoptimizationoptions/svgoptimizationoptions

Initializes a new instance of the SVGOptimizationOptions class. This is the default constructor and sets up the object with default optimization settings.

```csharp
public SVGOptimizationOptions()
```

--------------------------------

### Initialize PdfEncryptionInfo

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering.pdf.encryption/pdfencryptioninfo/__init__

Initializes a new instance of the PdfEncryptionInfo class with user password, owner password, permissions, and encryption algorithm.

```python
def __init__(self, user_password, owner_password, permissions, encryption_algorithm):
    ...
```

--------------------------------

### Get and Set xml_encoding Property

Source: https://reference.aspose.com/svg/python-net/aspose.svg.dom/entity/xml_encoding

This snippet shows how to get and set the xml_encoding property for an entity. It is null if not specified.

```python
def xml_encoding(self):
    ...
def xml_encoding(self, value):
    ...
```

--------------------------------

### BeginElement Method Signature

Source: https://reference.aspose.com/svg/net/aspose.svg.rendering/device-2/beginelement

This method begins rendering of the node. It returns true if the element should be processed. Requires the Element and its bounding box.

```csharp
public virtual bool BeginElement(Element element, RectangleF rect)
```

--------------------------------

### Get and Set Attribute Value

Source: https://reference.aspose.com/svg/python-net/aspose.svg.collections/domtokenlist/value

Use the value property to get or set the value of an attribute. This is part of the DOMTokenList.

```python
Copy@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

--------------------------------

### Configuration.Create(Action<IConfigurationBuilder>)

Source: https://reference.aspose.com/svg/net/aspose.svg/configuration/create

Creates and configures an instance of the Configuration object using a configuration builder.

```APIDOC
## Create(Action<IConfigurationBuilder>)

### Description
Create and configure the instance of Configuration object.

### Method
`public static Configuration Create(Action<IConfigurationBuilder> configure)`

### Parameters
#### Path Parameters
- **configure** (Action<IConfigurationBuilder>) - Required - The configuration builder

### Return Value
The instance of Configuration object.

### See Also
* interface IConfigurationBuilder
* class Configuration
* namespace Aspose.Svg
* assembly Aspose.SVG
```

--------------------------------

### Get or Set Vertical Resolution

Source: https://reference.aspose.com/svg/net/aspose.svg.services/ideviceinformationservice/verticalresolution

Use this property to get or set the vertical resolution. It returns a Resolution object.

```csharp
public Resolution VerticalResolution { get; set; }
```

--------------------------------

### begin_document Method

Source: https://reference.aspose.com/svg/python-net/aspose.svg.rendering/idevice/begin_document

Begins the rendering process for a document.

```APIDOC
## begin_document

### Description
Begins rendering of the document.

### Method
```python
def begin_document(self, document):
    ...
```

### Parameters
* **document** (aspose.svg.dom.Document) - Required - The document to render.

### See Also
* module `aspose.svg.rendering`
* class `IDevice`
```
Tokens:
Raw