OlePackage.FileName Property

Gets or sets the OLE Package file name.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

string FileName { get; set; }

VB.NET

Property FileName As String

Property Value

Type	Description
String	The source file name.

Example

The following example embeds an OLE package in the document. The OLE package contains compressed files in the zip archive format.

C#

using DevExpress.XtraRichEdit.API.Native;
using System.IO;
using System.Drawing;
// ...

Document document = wordProcessor.Document;
// Embed a zip archive in the document.
// Display the OLE object as an icon.
using (Stream zipStream = File.Open(@"D:\Attachment.zip", FileMode.Open))
{
    Shape oleObject = document.Shapes.InsertOleObjectAsIcon(document.Range.Start, zipStream,
        OleObjectType.Package, DocumentImageSource.FromFile(@"Images\Package.ico"));
    oleObject.OleFormat.OlePackage.FileName = "D:\\Attachment.zip";
    oleObject.OleFormat.OlePackage.DisplayName = "DocumentAttachment.zip";
     // Specify the object position on the page.
    oleObject.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Column;
    oleObject.RelativeVerticalPosition = ShapeRelativeVerticalPosition.Paragraph;
    oleObject.Offset = new PointF(0, 0);
}

VB.NET

Imports DevExpress.XtraRichEdit.API.Native
Imports System.IO
Imports System.Drawing
' ...

Dim document As Document = wordProcessor.Document
' Embed a zip archive in the document.
' Display the OLE object as an icon.
Using zipStream As Stream = File.Open("D:\Attachment.zip", FileMode.Open)
    Dim oleObject As Shape = document.Shapes.InsertOleObjectAsIcon(document.Range.Start, zipStream, 
        OleObjectType.Package, DocumentImageSource.FromFile("Images\Package.ico"))
    oleObject.OleFormat.OlePackage.FileName = "D:\Attachment.zip"
    oleObject.OleFormat.OlePackage.DisplayName = "DocumentAttachment.zip"
     ' Specify the object position on the page.
    oleObject.RelativeHorizontalPosition = ShapeRelativeHorizontalPosition.Column
    oleObject.RelativeVerticalPosition = ShapeRelativeVerticalPosition.Paragraph
    oleObject.Offset = New PointF(0, 0)
End Using